You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Flexible and lightweight building block for dataset and model versioning.
8
8
@@ -24,11 +24,11 @@ begin with `add`. Once the artifact has all the desired files, you can call
24
24
| Args ||
25
25
| :--- | :--- |
26
26
|`name`| A human-readable name for the artifact. Use the name to identify a specific artifact in the W&B App UI or programmatically. You can interactively reference an artifact with the `use_artifact` Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project. |
27
-
|`type`| The artifact's type. Use the type of an artifact to both organize and differentiate artifacts. You can use any string that contains letters, numbers, underscores, hyphens, and dots. Common types include `dataset` or `model`. Include `model` within your type string if you want to link the artifact to the W&B Model Registry. |
27
+
|`type`| The artifact's type. Use the type of an artifact to both organize and differentiate artifacts. You can use any string that contains letters, numbers, underscores, hyphens, and dots. Common types include `dataset` or `model`. Note: Some types are reserved for internal use and cannot be set by users. Such types include `job` and types that start with `wandb-`. |
28
28
|`description`| A description of the artifact. For Model or Dataset Artifacts, add documentation for your standardized team model or dataset card. View an artifact's description programmatically with the `Artifact.description` attribute or programmatically with the W&B App UI. W&B renders the description as markdown in the W&B App. |
29
29
|`metadata`| Additional information about an artifact. Specify metadata as a dictionary of key-value pairs. You can specify no more than 100 total keys. |
30
30
|`incremental`| Use `Artifact.new_draft()` method instead to modify an existing artifact. |
31
-
|`use_as`|W&B Launch specific parameter. Not recommended for general use. |
31
+
|`use_as`|Deprecated. |
32
32
|`is_link`| Boolean indication of if the artifact is a linked artifact(`True`) or source artifact(`False`). |
33
33
34
34
| Returns ||
@@ -68,13 +68,14 @@ begin with `add`. Once the artifact has all the desired files, you can call
68
68
|`type`| The artifact's type. Common types include `dataset` or `model`. |
69
69
|`updated_at`| The time when the artifact was last updated. |
70
70
|`url`| Constructs the URL of the artifact. |
71
+
|`use_as`| Deprecated. |
71
72
|`version`| The artifact's version. A string with the format `v{number}`. If the artifact is a link artifact, the version will be from the linked collection. |
@@ -121,6 +123,7 @@ Add a local directory to the artifact.
121
123
|`name`| The subdirectory name within an artifact. The name you specify appears in the W&B App UI nested by artifact's `type`. Defaults to the root of the artifact. |
122
124
|`skip_cache`| If set to `True`, W&B will not copy/move files to the cache while uploading |
123
125
|`policy`| "mutable" | "immutable". By default, "mutable" "mutable": Create a temporary copy of the file to prevent corruption during upload. "immutable": Disable protection, rely on the user not to delete or change the file. |
126
+
|`merge`| If `False` (default), throws ValueError if a file was already added in a previous add_dir call and its content has changed. If `True`, overwrites existing files with changed content. Always adds new files and never removes files. To replace an entire directory, pass a name when adding the directory using `add_dir(local_path, name=my_prefix)` and call `remove(my_prefix)` to remove the directory, then add it again. |
124
127
125
128
| Raises ||
126
129
| :--- | :--- |
@@ -129,7 +132,7 @@ Add a local directory to the artifact.
0 commit comments