-
Notifications
You must be signed in to change notification settings - Fork 42
Log models #504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Log models #504
Conversation
noaleetz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
new suggestions!!!
docs/guides/track/log/log-models.md
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
noaleetz
left a comment
There was a problem hiding this 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
docs/guides/track/log/log-models.md
Outdated
| ## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
There was a problem hiding this comment.
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.
noaleetz
left a comment
There was a problem hiding this 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!
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
Xin the boxes that apply.yarn start. My changes did not break the local preview.yarn docusaurus build) was run locally and successfully without errors or warnings.maininto my feature branch before submitting this PR.