File#

class geodesic.boson.dataset.File(path, dataset=None)[source]#

Access to a file created on a Dataset.

This class provides access to a file that has been created on a Dataset. It allows you to download, delete, share, or check the status of the file.

Parameters:
  • path (str) – the path to the file

  • dataset (Dataset) – the Dataset that the file belongs to

Methods

delete()

Deletes this file from the Dataset.

download([out_dir])

Downloads this file to the specified directory.

share([alias, description, ttl, create_new, ...])

Share this File publicly.

status()

Returns the creation status of this file.