Artifact

Properties


  • url Url
    This is generated by backend and expires after 1 hour. So this property might be out of date.
    Calling sync() method will retrieve a new url when expired.

  • id Id

  • object_name Object name

  • filename Filename


  • large If true, this (Object) has a large size

  • filename Filename of this (Artifact)

  • large If true, this (Artifact) has a large size

  • name

  • object_name


Methods

reset_url

reset_url()

Description

Reset url of this object


download

download(
   target_path: Union[str, Path] = './', force_replace: bool = False,
   use_id: bool = False
)

Description

Download this object into given target_path

Examples

data = clt.get_datalake().list_data(limit=1)
data.download('./data/')

Arguments

  • target_path (str, optional) : Target path where data will be downloaded. Defaults to './'.

  • force_replace (bool, optional) : Replace an existing file if exists. Defaults to False.

  • use_id (bool, optional) : If true, will download file with id and extension as file name. Defaults to False.


reset_url

reset_url()

Description

Reset url property of this Artifact by calling platform.

Returns

A url as str of this Artifact.


update

update(
   name: Optional[str] = None, filename: Optional[str] = None,
   object_name: Optional[str] = None, large: Optional[bool] = None
)

Description

Update this artifact with a new name, filename, object_name or large

Examples

this_artifact.update(object_name="another-path-to-artifact")

Arguments

  • name (str, optional) : New name of the artifact. Defaults to None.

  • filename (str, optional) : New filename of the artifact. Defaults to None.

  • object_name (str, optional) : New object_name of the artifact. Defaults to None.

  • large (bool, optional) : New large of the artifact. Defaults to None.


delete

delete()

Description

Delete this artifact

Examples

this_artifact.delete()