Datasets
Models representing datasets.
- class renku.domain_model.dataset.AnnotationJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
Schema for Annotations.
- class renku.domain_model.dataset.Dataset(*args, **kwargs)[source]
Bases:
renku.infrastructure.persistent.Persistent
Represent a dataset.
- property creators_csv
Comma-separated list of creators associated with dataset.
- property creators_full_csv
Comma-separated list of creators with full identity.
- derive_from(dataset, creator, identifier=None, date_created=None)[source]
Make self a derivative of dataset and update related fields.
- property files
Return list of existing files.
- property keywords_csv
Comma-separated list of keywords associated with dataset.
- replace_identifier(identifier=None)[source]
Replace dataset’s identifier and update relevant fields.
NOTE: Call this only for newly-created/-imported datasets that don’t have a mutability chain because it sets initial_identifier.
- class renku.domain_model.dataset.DatasetCreatorsJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
Schema for the dataset creators.
- class renku.domain_model.dataset.DatasetDetailsJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
Serialize a dataset to a response object.
- class renku.domain_model.dataset.DatasetFile(*, entity, based_on=None, date_added=None, date_removed=None, id=None, is_external=False, source=None)[source]
Bases:
renku.infrastructure.immutable.Slots
A file in a dataset.
- classmethod from_path(client, path, source=None, based_on=None)[source]
Return an instance from a path.
- static generate_id()[source]
Generate an identifier for DatasetFile.
NOTE: ID should not rely on Entity properties because the same Entity can be added and removed multiple times. So, it should be marked by different DatasetFiles.
- class renku.domain_model.dataset.DatasetFileDetailsJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
Serialize dataset files to a response object.
- class renku.domain_model.dataset.DatasetTag(*args, **kwargs)[source]
Bases:
renku.infrastructure.persistent.Persistent
Represents a Tag of an instance of a dataset.
- class renku.domain_model.dataset.ImageObject(*, content_url, id, position)[source]
Bases:
renku.infrastructure.immutable.Slots
Represents a schema.org ImageObject.
- property is_absolute
Whether content_url is an absolute or relative url.
- class renku.domain_model.dataset.ImageObjectJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
ImageObject json schema.
- class renku.domain_model.dataset.ImageObjectRequestJson(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]
Bases:
marshmallow.schema.Schema
ImageObject json schema.
- class renku.domain_model.dataset.Language(name, alternate_name=None, id=None)[source]
Bases:
renku.infrastructure.immutable.Immutable
Represent a language of an object.
- class renku.domain_model.dataset.RemoteEntity(*, checksum, id=None, path, url)[source]
Bases:
renku.infrastructure.immutable.Slots
Reference to an Entity in a remote repository.
- class renku.domain_model.dataset.Url(*, id=None, url=None, url_str=None, url_id=None)[source]
Bases:
object
Represents a schema URL reference.
- property value
Returns the url value as string.