Adds neptune plugin example #1723
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Thomas J. Fan <[email protected]>
Signed-off-by: Thomas J. Fan <[email protected]>
neverett
requested changes
Aug 16, 2024
examples/neptune_plugin/README.md
Outdated
| .. tags:: Integration, Data, Metrics, Intermediate | ||
| ``` | ||
|
|
||
| Neptune is the MLOps stack component for experiment tracking. It offers a single place to log, compare, store, and collaborate on experiments and models. This plugin enables seamless use of Neptune within Flyte by configuring links between the two platforms. |
There was a problem hiding this comment.
I would link to Neptune docs here (assuming that's https://docs.neptune.ai/)
examples/neptune_plugin/README.md
Outdated
| pip install flytekitplugins-neptune | ||
| ``` | ||
|
|
||
| To enable dynamic log links, add plugin to Flyte's configuration file: |
There was a problem hiding this comment.
Suggested change
| To enable dynamic log links, add plugin to Flyte's configuration file: | |
| To enable dynamic log links, add the plugin to Flyte's configuration file: |
| # %% [markdown] | ||
| # (neptune_example)= | ||
| # | ||
| # # Neptune Example |
There was a problem hiding this comment.
Suggested change
| # # Neptune Example | |
| # # Neptune example |
| from flytekitplugins.neptune import neptune_init_run | ||
|
|
||
| # %% [markdown] | ||
| # First, we specify the neptune project that we will use with Neptune |
There was a problem hiding this comment.
Suggested change
| # First, we specify the neptune project that we will use with Neptune | |
| # First, we specify the Neptune project that we will use with Neptune. |
|
|
||
| # %% [mardkwon] | ||
| # Next, we use `ImageSpec` to construct a container with the dependencies for our | ||
| # XGBoost training task. Please set the `REGISTRY` to an registry that your cluster can access; |
There was a problem hiding this comment.
Suggested change
| # XGBoost training task. Please set the `REGISTRY` to an registry that your cluster can access; | |
| # XGBoost training task. Please set the `REGISTRY` to a registry that your cluster can access. |
| # %% | ||
| # Next, we use the `neptune_init_run` decorator to configure Flyte to train an XGBoost | ||
| # model. The decorator requires an `api_key` secret to authenticate with Neptune and | ||
| # the task definition needs to requests the same `api_key` secret. In the training |
There was a problem hiding this comment.
Suggested change
| # the task definition needs to requests the same `api_key` secret. In the training | |
| # the task definition needs to request the same `api_key` secret. In the training |
| # %% [markdown] | ||
| # First, we specify the neptune project that we will use with Neptune | ||
| # Please update `NEPTUNE_PROJECT` to the value associated with your account. | ||
| WANDB_PROJECT = "username/project" |
There was a problem hiding this comment.
Should this be NEPTUNE_PROJECT instead of WANDB_PROJECT?
| secret_requests=[api_key], | ||
| requests=Resources(cpu="2", mem="4Gi"), | ||
| ) | ||
| @neptune_init_run(project=WANDB_PROJECT, secret=api_key) |
There was a problem hiding this comment.
If WANDB_PROJECT is changed above, this should also be updated.
|
|
||
|
|
||
| # %% | ||
| # With Flyte's dynamic workflows, we scale up multiple training jobs with different |
There was a problem hiding this comment.
Suggested change
| # With Flyte's dynamic workflows, we scale up multiple training jobs with different | |
| # With Flyte's dynamic workflows, we can scale up multiple training jobs with different |
Signed-off-by: Thomas J. Fan <[email protected]>
Signed-off-by: Thomas J. Fan <[email protected]>
…ne_plugin_docs Signed-off-by: Thomas J. Fan <[email protected]>
Signed-off-by: Thomas J. Fan <[email protected]>
cosmicBboy
reviewed
Oct 4, 2024
| # [Flyte's Secrets manager](https://docs.flyte.org/en/latest/user_guide/productionizing/secrets.html). | ||
| api_key = Secret(key="neptune-api-token", group="neptune-api-group") | ||
|
|
||
| # %% [mardkwon] |
| WANDB_PROJECT = "username/project" | ||
|
|
||
| # %% [markdown] | ||
| # W&B requires an API key to authenticate with their service. In the above example, |
Signed-off-by: Thomas J. Fan <[email protected]>
Signed-off-by: Thomas J. Fan <[email protected]>
…ne_plugin_docs Signed-off-by: Thomas J. Fan <[email protected]>
Signed-off-by: Thomas J. Fan <[email protected]>
neverett
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for the neptune plugin.