Creating Models

Create a Code Ocean Model by registering it in MLflow, or from the Capsule or Pipeline Timeline.

Registering Models in MLflow

Register models for lifecycle management and version control. Creating registered models allows you to track changes over time, while also enabling easy access to previous model versions for comparison.

By registering a model in MLflow, a Registered Model is also created in your Code Ocean Models dashboard, complete with provenance and lineage.

Follow these steps to register a model from a completed run, in the MLflow UI:

1. Open the MLflow UI from the Navigation Sidebar, or from within a Capsule or Pipeline.

2. Go to the Experiments tab.

3. Click on the Model from the run which you wish to register.

4. Click Register Model.

5. Select from the dropdown an existing model or Create New Model.

6. Click Register to complete the registration process.

Creating Models from the Timeline

In addition to registering models in the MLflow UI, you can also capture any computation model, indicated in the Capsule or Pipeline Timeline by a “Model” icon, as a Code Ocean Model that includes automatically-generated provenance and lineage. These Models can be shared and attached to a Capsule or Pipeline for downstream analysis.

Code Ocean Models can only be created using MLflow integration.

Before capturing a model, verify that you:

1. Save the model under the /results folder and that the model files are visible in the Timeline.

2. Commit all the changes in the Capsule (click Commit Changes in the Timeline if not done yet).

Capture a Model by following these steps:

1. In your Capsule or Pipeline's Timeline, go to the model you want to capture and click the actions menu.

2. Select Create New Model.

3. Enter the following information:

   • Model Name (required)—Use a meaningful name so that others can find the model easily.

   • Folder Name (required)—The folder name inside a Capsule. Use a name that’s similar to the model name. Spaces and some special characters are not allowed here.

   • Description (optional)—Add some text to make the model easy to find and understand.

   • Tags (optional)—Tags are another way to help other users find your model.

   • Custom Metadata

4. Click "Create New Model"

After you’ve created the Model, you’ll get a link to view it on the Models page. There, you can validate that you’ve captured the correct model, edit, download and share with others.