Neptune
Logging and visualizing experiments with neptune.ai
Neptune
When would you want to use it?
You should use the Neptune Experiment Tracker:
if you have already been using neptune.ai to track experiment results for your project and would like to continue doing so as you are incorporating MLOps workflows and best practices in your project through ZenML.
if you are looking for a more visually interactive way of navigating the results produced from your ZenML pipeline runs (e.g. models, metrics, datasets)
if you would like to connect ZenML to neptune.ai to share the artifacts and metrics logged by your pipelines with your team, organization, or external stakeholders
How do you deploy it?
The Neptune Experiment Tracker flavor is provided by the Neptune-ZenML integration. You need to install it on your local machine to be able to register the Neptune Experiment Tracker and add it to your stack:
The Neptune Experiment Tracker needs to be configured with the credentials required to connect to Neptune using an API token.
Authentication Methods
You need to configure the following credentials for authentication to Neptune:
project
: The name of the project where you're sending the new run, in the form "workspace-name/project-name". If the project is not specified, Neptune will attempt to retrieve it from your environment variables.
This option configures the credentials for neptune.ai directly as stack component attributes.
This is not recommended for production settings as the credentials won't be stored securely and will be clearly visible in the stack configuration.
How do you use it?
To log information from a ZenML pipeline step using the Neptune Experiment Tracker component in the active stack, you need to enable an experiment tracker using the @step
decorator. Then fetch the Neptune run object and use logging capabilities as you would normally do. For example:
Neptune UI
Neptune comes with a web-based UI that you can use to find further details about your tracked experiments. Each pipeline run will be logged as a separate experiment run in Neptune, which you can inspect in the Neptune UI:
You can find the URL of the Neptune experiment linked to a specific ZenML run via the metadata of the step in which the experiment tracker was used:
Alternatively, you can see an overview of all experiment runs at https://app.neptune.ai/{ACCOUNT_USERNAME}/{PROJECT_NAME}.
Additional configuration
You can pass a set of tags to the Neptune run by using the NeptuneExperimentTrackerSettings
class, like in the example below:
Last updated