Skip to content

Conversation

@ngrayluna
Copy link
Contributor

Description

What does the pull request do? If it fixes a bug or resolves a feature request, be sure to link to that issue.

Ticket

Does this PR fix an existing issue? If yes, provide a link to the ticket here:

Checklist

Check if your PR fulfills the following requirements. Put an X in the boxes that apply.

  • Files I edited were previewed on my local development server with yarn start. My changes did not break the local preview.
  • Build (yarn docusaurus build) was run locally and successfully without errors or warnings.
  • I merged the latest changes from main into my feature branch before submitting this PR.

@ngrayluna ngrayluna requested a review from a team as a code owner December 4, 2023 21:57
@ngrayluna ngrayluna requested a review from noaleetz December 4, 2023 21:57
Copy link
Contributor

@noaleetz noaleetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new suggestions!!!


If the `'registered-model-name'` matches the name of a registered model that already exists within the Model Registry, the model will be linked to that registered model. If no such registered model exists, a new one will be created and the model will be the first one linked.

For example, suppose you have an existing registered model named "Fine-Tuned Review Autocompletion" in your Model Registry (see example [here](https://wandb.ai/reviewco/registry/model?selectionPath=reviewco%2Fmodel-registry%2FFinetuned-Review-Autocompletion&view=all-models)). And suppose that a few model versions have already been linked to it: v0, v1, v2. If you call `link_model` with `registered-model-name="Fine-Tuned Review Autocompletion"`, the new model will be linked to this existing Registered Model as v4. If no Registered Model with this name exists, a new one will be created and the new model will be linked as v0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, suppose you have an existing registered model named "Fine-Tuned Review Autocompletion" in your Model Registry (see example [here](https://wandb.ai/reviewco/registry/model?selectionPath=reviewco%2Fmodel-registry%2FFinetuned-Review-Autocompletion&view=all-models)). And suppose that a few model versions have already been linked to it: v0, v1, v2. If you call `link_model` with `registered-model-name="Fine-Tuned Review Autocompletion"`, the new model will be linked to this existing Registered Model as v4. If no Registered Model with this name exists, a new one will be created and the new model will be linked as v0.
For example, suppose you have an existing registered model named "Finetuned-Review-Autocompletion" in your Model Registry (see example [here](https://wandb.ai/reviewco/registry/model?selectionPath=reviewco%2Fmodel-registry%2FFinetuned-Review-Autocompletion&view=all-models)). And suppose that a few model versions have already been linked to it: v0, v1, v2. If you call `[link_model](../../../ref/python/run.md#link_model)` with `registered-model-name="Finetuned-Review-Autocompletion"`, the new model will be linked to this existing registered model as v4. If no registered model with this name exists, a new one will be created and the new model will be linked as v0.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@noaleetz The code example shows Fine-Tuned Review Autocompletion

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha - can we updated the code example to also be "Finetuned-Review-Autocompletion" (I can't find where to leave that suggestion)? Anywhere where we use this registered model name - this way it matches ex registry linked

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to : "Fine-Tuned-Review-Autocompletion"

Copy link
Contributor

@noaleetz noaleetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a tiny bit more tweaks

@ngrayluna ngrayluna requested a review from noaleetz December 6, 2023 20:40
## Log a model to a W&B run
Use the [`log_model`](../../../ref/python/run.md#log_model) to log a model artifact that contains content within a directory you specify. The [`log_model`](../../../ref/python/run.md#log_model) method also marks the resulting model artifact as an output of the W&B run.

Models that are marked as the input or output to a run to track the lineage of that model. A model's lineage graph shows the model's dependencies and the model's associations. You can view the lineage of the model within the W&B App UI. See the [Explore and traverse artifact graphs](../../artifacts/explore-and-traverse-an-artifact-graph.md) page within the [Artifacts](../../artifacts/intro.md) chapter for more information.
Copy link
Contributor

@noaleetz noaleetz Dec 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Models that are marked as the input or output to a run to track the lineage of that model. A model's lineage graph shows the model's dependencies and the model's associations. You can view the lineage of the model within the W&B App UI. See the [Explore and traverse artifact graphs](../../artifacts/explore-and-traverse-an-artifact-graph.md) page within the [Artifacts](../../artifacts/intro.md) chapter for more information.
Models that are marked as an output to a run will be tracked inside the project's lineage graph. A lineage graph shows the model's dependencies and the model's associations. You can view the lineage of the model within the W&B App UI. See the [Explore and traverse artifact graphs](../../artifacts/explore-and-traverse-an-artifact-graph.md) page within the [Artifacts](../../artifacts/intro.md) chapter for more information.

Copy link
Contributor Author

@ngrayluna ngrayluna Dec 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, I changed it to: You can track a model's dependencies and the model's associations if you mark the model as the input or output of a W&B run.

Copy link
Contributor

@noaleetz noaleetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#504 (comment) final change and can merge!

@ngrayluna ngrayluna merged commit 984ec0d into main Dec 6, 2023
@johndmulhausen johndmulhausen deleted the model_reg_new_apis branch September 5, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants