| title |
|---|
Artifacts |
class ArtifactsCache(object) | __init__(cache_dir) | check_md5_obj_path(b64_md5, size) | check_etag_obj_path(etag, size)get_artifacts_cache()class Artifact(object)An artifact object you can write files into, and pass to log_artifact.
| __init__(name, type, description=None, metadata=None) | @property
| id() | @property
| entity() | @property
| project() | @property
| manifest() | @property
| digest() | new_file(name, mode="w") | add_file(local_path, name=None) | add_dir(local_path, name=None) | add_reference(uri, name=None, checksum=True, max_objects=None) | add(obj, name)Adds obj to the artifact, located at name. You can use Artifact#get(name) after downloading
the artifact to retrieve this object.
Arguments:
objwandb.Media - The object to save in an artifactnamestr - The path to save
| get_added_local_path_name(local_path)If local_path was already added to artifact, return its internal name.
| get_path(name) | download() | finalize()class ArtifactManifestV1(ArtifactManifest) | @classmethod
| version(cls) | @classmethod
| from_manifest_json(cls, artifact, manifest_json) | __init__(artifact, storage_policy, entries=None) | to_manifest_json()This is the JSON that's stored in wandb_manifest.json
If include_local is True we also include the local paths to files. This is used to represent an artifact that's waiting to be saved on the current system. We don't need to include the local paths in the artifact manifest contents.
| digest()class ArtifactManifestEntry(object) | __init__(path, ref, digest, birth_artifact_id=None, size=None, extra=None, local_path=None) | __repr__()class WandbStoragePolicy(StoragePolicy) | @classmethod
| name(cls) | @classmethod
| from_config(cls, config) | __init__(config=None) | config() | load_file(artifact, name, manifest_entry) | store_reference(artifact, path, name=None, checksum=True, max_objects=None) | load_reference(artifact, name, manifest_entry, local=False) | store_file(artifact_id, entry, preparer, progress_callback=None)class __S3BucketPolicy(StoragePolicy) | @classmethod
| name(cls) | @classmethod
| from_config(cls, config) | __init__(bucket) | config() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class MultiHandler(StorageHandler) | __init__(handlers=None, default_handler=None) | @property
| scheme() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class TrackingHandler(StorageHandler) | __init__(scheme=None)Tracks paths as is, with no modification or special processing. Useful when paths being tracked are on file systems mounted at a standardized location.
For example, if the data to track is located on an NFS share mounted on /data, then it is sufficient to just track the paths.
| @property
| scheme() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=False, max_objects=None)class LocalFileHandler(StorageHandler)Handles file:// references
| __init__(scheme=None)Tracks files or directories on a local filesystem. Directories are expanded to create an entry for each file contained within.
| @property
| scheme() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class S3Handler(StorageHandler) | __init__(scheme=None) | @property
| scheme() | init_boto() | versioning_enabled(bucket) | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class GCSHandler(StorageHandler) | __init__(scheme=None) | versioning_enabled(bucket) | @property
| scheme() | init_gcs() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class HTTPHandler(StorageHandler) | __init__(session, scheme=None) | @property
| scheme() | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)class WBArtifactHandler(StorageHandler)Handles loading and storing Artifact reference-type files
| __init__(scheme=None) | @property
| scheme() | @staticmethod
| parse_path(path) | load_path(artifact, manifest_entry, local=False) | store_path(artifact, path, name=None, checksum=True, max_objects=None)