SDK Release: Manual SDK v23.0 (#1895)

## Description

Manual SDK Release for v23.0
Fixed some rendering issues in source. See accompanying PR:
wandb/wandb#10930

<!-- Uncomment and add a description of the change -->


<!-- Optionally, uncomment the heading and add details about how you
tested the change and how reviewers should test it. For example:
## Testing
- [ ] Local build succeeds without errors (`mint dev`)
- [ ] Local link check succeeds without errors (`mint broken-links`)
- [ ] PR tests succeed

Replace the `[ ]` with `[x]` to check off the item instead of leaving it
unchecked.

Otherwise, delete this entire section from opening to closing comment.
-->

<!-- Optionally, uncomment the heading and add one or more lines like
these. Otherwise, delete this entire section from opening to closing
comment.

## Related issues

- Fixes DOCS-12345
- Fixes #12345
-->

Author: ngrayluna

models/ref/python.mdx

@@ -1,5 +1,5 @@
 ---
-title: Python SDK 0.22.2
+title: Python SDK 0.23.0
 module:
 ---
 The W&B Python SDK, accessible at `wandb`, enables you to train and fine-tune models, and manage models from experimentation to production. 

models/ref/python/automations/automation.mdx

@@ -10,14 +10,14 @@ import { GitHubLink } from '/snippets/en/_includes/github-source-link.mdx';
 
 
 ## <kbd>class</kbd> `Automation`
-A local instance of a saved W&B automation.
+A local instance of a saved W&B automation that supports editing.
 
 
 ### <kbd>method</kbd> `Automation.__init__`
 
 ```python
 __init__(
-    typename__: 'Literal['Trigger']' = 'Trigger',
+    typename__: 'Literal' = 'Trigger',
     id: 'str',
     created_at: 'datetime',
     updated_at: 'datetime | None' = None,
@@ -32,7 +32,7 @@ __init__(
 
 **Args:**
 
- - `typename__` (Literal['Trigger']): 
+ - `typename__` (Literal): 
  - `id` (str): 
  - `created_at` (datetime): The date and time when this automation was created.
  - `updated_at` (Optional[datetime]): The date and time when this automation was last updated, if applicable.

models/ref/python/automations/metricchangefilter.mdx

@@ -10,7 +10,7 @@ import { GitHubLink } from '/snippets/en/_includes/github-source-link.mdx';
 
 
 ## <kbd>class</kbd> `MetricChangeFilter`
-Defines a filter that compares a change in a run metric against a user-defined threshold.
+Filter that compares a **change** in a metric value to a user-defined threshold.
 
 The change is calculated over "tumbling" windows, i.e. the difference
 between the current window and the non-overlapping prior window.
@@ -38,7 +38,7 @@ __init__(
  - `window` (int): 
  - `cmp` (None): Ignored.
  - `threshold` (Union[Annotated, Annotated]): 
- - `prior_window` (int): Size of the prior window over which the metric is aggregated (ignored if `agg is None`).
+ - `prior_window` (int): Size of the "prior" metric aggregation window (ignored if `agg` is ``None``).
    If omitted, defaults to the size of the current window.
  - `change_type` (ChangeType): 
  - `change_dir` (ChangeDir): 

models/ref/python/automations/metricthresholdfilter.mdx

@@ -10,7 +10,7 @@ import { GitHubLink } from '/snippets/en/_includes/github-source-link.mdx';
 
 
 ## <kbd>class</kbd> `MetricThresholdFilter`
-Defines a filter that compares a run metric against a user-defined threshold value.
+Filter that compares a metric value against a user-defined threshold.
 
 
 ### <kbd>method</kbd> `MetricThresholdFilter.__init__`
@@ -30,7 +30,7 @@ __init__(
  - `name` (str): 
  - `agg` (Optional[Agg]): 
  - `window` (int): 
- - `cmp` (Literal['$gte', '$gt', '$lt', '$lte']): Comparison operator used to compare the metric value (left) vs. the threshold value (right).
+ - `cmp` (Literal['$gte', '$gt', '$lt', '$lte']): Comparison operator between the metric value (left) vs. the threshold (right).
  - `threshold` (Union[Annotated, Annotated]): 
 
 **Returns:**

models/ref/python/automations/onaddartifactalias.mdx

@@ -27,7 +27,7 @@ __init__(
 
  - `event_type` (Literal[ADD_ARTIFACT_ALIAS]): 
  - `scope` (Union[_ArtifactSequenceScope, _ArtifactPortfolioScope, ProjectScope]): The scope of the event.
- - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional condition(s), if any, that must be met for this event to trigger an automation.
+ - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional conditions(s), if any, that are required for this event to trigger.
 
 **Returns:**
  An `OnAddArtifactAlias` object.

models/ref/python/automations/oncreateartifact.mdx

@@ -26,8 +26,8 @@ __init__(
 **Args:**
 
  - `event_type` (Literal[CREATE_ARTIFACT]): 
- - `scope` (Union[_ArtifactSequenceScope, _ArtifactPortfolioScope]): The scope of the event: only artifact collections are valid scopes for this event.
- - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional condition(s), if any, that must be met for this event to trigger an automation.
+ - `scope` (Union[_ArtifactSequenceScope, _ArtifactPortfolioScope]): The scope of the event: must be an artifact collection.
+ - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional conditions(s), if any, that are required for this event to trigger.
 
 **Returns:**
  An `OnCreateArtifact` object.

models/ref/python/automations/onlinkartifact.mdx

@@ -27,7 +27,7 @@ __init__(
 
  - `event_type` (Literal[LINK_ARTIFACT]): 
  - `scope` (Union[_ArtifactSequenceScope, _ArtifactPortfolioScope, ProjectScope]): The scope of the event.
- - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional condition(s), if any, that must be met for this event to trigger an automation.
+ - `filter` (Union[And, Or, Nor, Not, Lt, Gt, Lte, Gte, Eq, Ne, In, NotIn, Exists, Regex, Contains, Dict[str, Any], FilterExpr]): Additional conditions(s), if any, that are required for this event to trigger.
 
 **Returns:**
  An `OnLinkArtifact` object.

models/ref/python/automations/onrunmetric.mdx

@@ -26,8 +26,8 @@ __init__(
 **Args:**
 
  - `event_type` (Literal[RUN_METRIC_THRESHOLD, RUN_METRIC_CHANGE]): 
- - `scope` (ProjectScope): The scope of the event: only projects are valid scopes for this event.
- - `filter` (RunMetricFilter): Run and/or metric condition(s) that must be satisfied for this event to trigger an automation.
+ - `scope` (ProjectScope): The scope of the event: must be a project.
+ - `filter` (RunMetricFilter): Run and/or metric condition(s) that must be satisfied for this event to trigger.
 
 **Returns:**
  An `OnRunMetric` object.

models/ref/python/data-types/image.mdx

@@ -43,8 +43,8 @@ This class handles various image data formats and automatically normalizes pixel
  - `data_or_path`:  Accepts NumPy array/pytorch tensor of image data,  a PIL image object, or a path to an image file. If a NumPy  array or pytorch tensor is provided,  the image data will be saved to the given file type.  If the values are not in the range [0, 255] or all values are in the range [0, 1],  the image pixel values will be normalized to the range [0, 255]  unless `normalize` is set to `False`. 
     - pytorch tensor should be in the format (channel, height, width) 
     - NumPy array should be in the format (height, width, channel) 
- - `mode`:  The PIL mode for an image. Most common are "L", "RGB", 
- - `"RGBA". Full explanation at https`: //pillow.readthedocs.io/en/stable/handbook/concepts.html#modes 
+ - `mode`:  The PIL mode for an image. Most common are "L", "RGB", "RGBA". 
+ - `Full Pillow docs for more information https`: //pillow.readthedocs.io/en/stable/handbook/concepts.html#modes 
  - `caption`:  Label for display of image. 
  - `grouping`:  The grouping number for the image. 
  - `classes`:  A list of class information for the image,  used for labeling bounding boxes, and image masks. 

models/ref/python/experiments/artifact.mdx

@@ -32,12 +32,11 @@ __init__(
 **Args:**
 
  - `name` (str):  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. 
- - `type` (str):  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. Note that some types reserved for internal use  and cannot be set by users. Such types include `job` and types that start with `wandb-`. 
- - `description (str | None) = None`:  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. 
- - `metadata (dict[str, Any] | None) = None`:  Additional information about an artifact. Specify metadata as a  dictionary of key-value pairs. You can specify no more than 100 total keys. 
+ - `type` (str):  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.  Note that some types reserved for internal use and cannot be set by users.  Such types include `job` and types that start with `wandb-`. 
+ - `description (str | None) = None`:  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. 
+ - `metadata (dict[str, Any] | None) = None`:  Additional information about an artifact.  Specify metadata as a dictionary of key-value pairs. You can specify no more  than 100 total keys. 
  - `incremental`:  Use `Artifact.new_draft()` method instead to modify an  existing artifact. 
  - `use_as`:  Deprecated. 
- - `is_link`:  Boolean indication of if the artifact is a linked artifact(`True`) or source artifact(`False`). 
 
 
 
@@ -68,9 +67,11 @@ Aliases are mutable references that you can programmatically reference. Change a
 
 ### <kbd>property</kbd> Artifact.collection
 
-The collection this artifact was retrieved from. 
+The collection this artifact is retrieved from. 
 
-A collection is an ordered group of artifact versions. If this artifact was retrieved from a portfolio / linked collection, that collection will be returned rather than the collection that an artifact version originated from. The collection that an artifact originates from is known as the source sequence. 
+A collection is an ordered group of artifact versions. If this artifact is retrieved from a collection that it is linked to, return that collection. Otherwise, return the collection that the artifact version originates from. 
+
+The collection that an artifact originates from is known as the source sequence. 
 
 
 
@@ -145,7 +146,7 @@ The number of files (including references).
 
 ### <kbd>property</kbd> Artifact.history_step
 
-The nearest step at which history metrics were logged for the source run of the artifact. 
+The nearest step which logged history metrics for this artifact's source run. 
 
 
 
@@ -193,7 +194,9 @@ True: The artifact is a link artifact to a source artifact. False: The artifact
 
 Returns a list of all the linked artifacts of a source artifact. 
 
-If the artifact is a link artifact (`artifact.is_link == True`), it will return an empty list. Limited to 500 results. 
+If this artifact is a link artifact (`artifact.is_link == True`), it will return an empty list. 
+
+Limited to 500 results. 
 
 
 
@@ -275,9 +278,9 @@ Includes any references tracked by this artifact.
 
 ### <kbd>property</kbd> Artifact.source_artifact
 
-Returns the source artifact. The source artifact is the original logged artifact. 
+Returns the source artifact, which is the original logged artifact. 
 
-If the artifact itself is a source artifact (`artifact.is_link == False`), it will return itself. 
+If this artifact is a source artifact (`artifact.is_link == False`), it will return itself. 
 
 
 
@@ -439,7 +442,7 @@ Deprecated.
 
 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. 
+A string with the format `v{number}`. If this is a link artifact, the version will be from the linked collection. 
 
 
 
@@ -504,9 +507,9 @@ Add a local directory to the artifact.
  - `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. 
  - `skip_cache`:  If set to `True`, W&B will not copy/move files to  the cache while uploading 
  - `policy`:  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. 
- - `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. 
+        - 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. 
+ - `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. 
 
 
 
@@ -590,7 +593,7 @@ For any other scheme, the digest is just a hash of the URI and the size is left
 
  - `uri`:  The URI path of the reference to add. The URI path can be an object  returned from `Artifact.get_entry` to store a reference to another  artifact's entry. 
  - `name`:  The path within the artifact to place the contents of this reference. 
- - `checksum`:  Whether or not to checksum the resource(s) located at the  reference URI. Checksumming is strongly recommended as it enables  automatic integrity validation. Disabling checksumming will speed up  artifact creation but reference directories will not iterated through so the  objects in the directory will not be saved to the artifact. We recommend  setting `checksum=False` when adding reference objects, in which case  a new version will only be created if the reference URI changes. 
+ - `checksum`:  Whether or not to checksum the resource(s) located at the  reference URI. Checksumming is strongly recommended as it enables  automatic integrity validation. Disabling checksumming will speed up  artifact creation but reference directories will not iterated through so  the objects in the directory will not be saved to the artifact.  We recommend setting `checksum=False` when adding reference objects,  in which case a new version will only be created if the reference URI  changes. 
  - `max_objects`:  The maximum number of objects to consider when adding a  reference that points to directory or bucket store prefix.  By default, the maximum number of objects allowed for Amazon S3,  GCS, Azure, and local files is 10,000,000. Other URI schemas  do not have a maximum. 
 
 
@@ -645,13 +648,13 @@ Delete an artifact and its files.
 
 If called on a linked artifact, only the link is deleted, and the source artifact is unaffected. 
 
-Use `artifact.unlink()` instead of `artifact.delete()` to remove a link between a source artifact and a linked artifact. 
+Use `Artifact.unlink()` instead of `Artifact.delete()` to remove a link between a source artifact and a collection. 
 
 
 
 **Args:**
 
- - `delete_aliases`:  If set to `True`, deletes all aliases associated  with the artifact. Otherwise, this raises an exception if  the artifact has existing aliases. This parameter is ignored  if the artifact is linked (a member of a portfolio collection). 
+ - `delete_aliases`:  If set to `True`, delete all aliases associated  with the artifact. If `False`, raise an exception if  the artifact has existing aliases. This parameter is ignored  if the artifact is retrieved from a collection it is linked to. 
 
 
 
@@ -685,7 +688,7 @@ Existing files located within `root` are not modified. Explicitly delete `root`
  - `allow_missing_references`:  If set to `True`, any invalid reference paths  will be ignored while downloading referenced files. 
  - `skip_cache`:  If set to `True`, the artifact cache will be skipped when  downloading and W&B will download each file into the default root or  specified download directory. 
  - `path_prefix`:  If specified, only files with a path that starts with the given  prefix will be downloaded. Uses unix format (forward slashes). 
- - `multipart`:  If set to `None` (default), the artifact will be downloaded  in parallel using multipart download if individual file size is greater than  2GB. If set to `True` or `False`, the artifact will be downloaded in  parallel or serially regardless of the file size. 
+ - `multipart`:  If set to `None` (default), the artifact will be downloaded  in parallel using multipart download if individual file size is greater  than 2GB. If set to `True` or `False`, the artifact will be downloaded in  parallel or serially regardless of the file size. 
 
 
 
@@ -887,17 +890,17 @@ Returns the artifact encoded to the JSON format.
 ### <kbd>method</kbd> `Artifact.link`
 
 ```python
-link(target_path: 'str', aliases: 'list[str] | None' = None) → Artifact
+link(target_path: 'str', aliases: 'Iterable[str] | None' = None) → Artifact
 ```
 
-Link this artifact to a portfolio (a promoted collection of artifacts). 
+Link this artifact to a collection. 
 
 
 
 **Args:**
 
- - `target_path`:  The path to the portfolio inside a project.  The target path must adhere to one of the following  schemas `{portfolio}`, `{project}/{portfolio}` or  `{entity}/{project}/{portfolio}`.  To link the artifact to the Model Registry, rather than to a generic  portfolio inside a project, set `target_path` to the following  schema `{"model-registry"}/{Registered Model Name}` or  `{entity}/{"model-registry"}/{Registered Model Name}`. 
- - `aliases`:  A list of strings that uniquely identifies the artifact  inside the specified portfolio. 
+ - `target_path`:  The path of the collection. Path consists of the prefix  "wandb-registry-" along with the registry name and the  collection name `wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}`. 
+ - `aliases`:  Add one or more aliases to the linked artifact. The  "latest" alias is automatically applied to the most recent artifact  you link. 
 
 
 
@@ -1040,14 +1043,14 @@ If currently in a run, that run will log this artifact. If not currently in a ru
 unlink() → None
 ```
 
-Unlink this artifact if it is currently a member of a promoted collection of artifacts. 
+Unlink this artifact if it is a linked member of an artifact collection. 
 
 
 
 **Raises:**
 
  - `ArtifactNotLoggedError`:  If the artifact is not logged. 
- - `ValueError`:  If the artifact is not linked, in other words, it is not a member of a portfolio collection. 
+ - `ValueError`:  If the artifact is not linked to any collection. 
 
 ---