Datasets¶
Model objects representing datasets.
Dataset object¶
-
class
renku.core.models.datasets.
Dataset
(*, commit=None, client=None, path=None, project: renku.core.models.projects.Project = None, parent=None, checksum: str = None, creators, id=None, label=None, date_published=None, description=None, identifier=NOTHING, in_language=None, images=None, keywords=None, license=None, title: str = None, url=None, version=None, date_created=NOTHING, files=NOTHING, tags=NOTHING, same_as=None, name=None, derived_from=None, immutable=False)[source]¶ Represent a dataset.
Method generated by attrs for class Dataset.
-
creators_csv
¶ Comma-separated list of creators associated with dataset.
-
creators_full_csv
¶ Comma-separated list of creators with full identity.
-
data_dir
¶ Directory where dataset files are stored.
-
default_id
()¶ Configure calculated ID.
-
default_label
()¶ Generate a default label.
-
editable
¶ Subset of attributes which user can edit.
-
entities
¶ Yield itself.
-
find_file
(path, return_index=False)[source]¶ Find a file in files container using its relative path.
-
classmethod
from_jsonld
(data, client=None, commit=None, schema_class=None)[source]¶ Create an instance from JSON-LD data.
-
classmethod
from_revision
(client, path, revision='HEAD', parent=None, find_previous=True, **kwargs)¶ Return dependency from given path and revision.
-
keywords_csv
¶ Comma-separated list of keywords associated with dataset.
-
mutate
()[source]¶ Update mutation history and assign a new identifier.
Do not mutate more than once before committing the metadata or otherwise there would be missing links in the chain of changes.
-
original_identifier
¶ Return the first identifier of the dataset.
-
parent
¶ Return the parent object.
-
set_client
(client)¶ Sets the clients on this entity.
-
short_id
¶ Shorter version of identifier.
-
submodules
¶ Proxy to client submodules.
Comma-separated list of tags associated with dataset.
-
Dataset file¶
Manage files in the dataset.
-
class
renku.core.models.datasets.
DatasetFile
(*, commit=None, client=None, path=None, id=None, label=NOTHING, project: renku.core.models.projects.Project = None, parent=None, added=NOTHING, checksum=None, filename=NOTHING, name=None, filesize=None, filetype=None, url=None, based_on=None, external=False, source=None)[source]¶ Represent a file in a dataset.
Method generated by attrs for class DatasetFile.
-
commit_sha
¶ Return commit hash.
-
default_id
()¶ Configure calculated ID.
-
default_label
()¶ Generate a default label.
-
entities
¶ Yield itself.
-
classmethod
from_revision
(client, path, revision='HEAD', parent=None, find_previous=True, **kwargs)¶ Return dependency from given path and revision.
-
full_path
¶ Return full path in the current reference frame.
-
parent
¶ Return the parent object.
-
set_client
(client)¶ Sets the clients on this entity.
-
size_in_mb
¶ Return file size in megabytes.
-
submodules
¶ Proxy to client submodules.
-