Academy Documentation
  • Usage of Academy Documentation
  • Getting Started
    • Background Information
    • For Apollo Users
    • For Titan Users
    • For Scientists
    • For HPC Users
    • For Experienced Users
  • Cloud Computing
    • General Information
    • Cloud Computing for Scientists
    • Cloud Computing for HPC Users
  • Overview of the Platform
    • Overview of the Platform User Interface
    • Tool Library and App Introduction
  • Billing Access and Orgs
    • Orgs and Account Management
    • Billing and Pricing
  • Cohort Browser
    • Apollo Introduction
    • Overview of the Cohort Browser
    • Combining Cohorts
    • Genomic Variant Browser
    • Somatic Variants
  • JSON
    • Introduction
    • JSON on the Platform
  • Command Line Interface (CLI)
    • Introduction to CLI
    • Advanced CLI
  • Building Applets
    • Introduction
    • Bash
      • Example 1: Word Count (wc)
      • Example 2: fastq_quality_trimmer
      • Example 3: samtools
      • Example 4: cnvkit
      • Example 5: samtools with a Docker Image
    • Python
      • Example 1: Word Count (wc)
      • Example 2: fastq_quality_trimmer
      • Example 3: cnvkit
    • Publishing Applets to Apps
  • Building Workflows
    • Native Workflows
    • WDL
      • Example 1: hello
      • Example 2: Word Count (wc)
      • Example 3: fastq_trimmer
      • Example 4: cnvkit
      • Example 5: workflow
    • Nextflow
      • Resources To Learn Nextflow
      • Overview of Nextflow
      • Nextflow Setup
      • Importing Nf-Core
      • Building Nextflow Applets
      • Error Strategies for Nextflow
      • Job Failures
      • Useful Information
  • Interactive Cloud Computing
    • Cloud Workstation
    • TTYD
    • TTYD vs Cloud Workstation
    • JupyterLab
      • Introduction
      • Running a JupyterLab Notebook
  • Docker
    • Using Docker
    • Creating Docker Snapshots
    • Running Docker with Swiss Army Knife
  • Portals
    • Overview of JSON files for Portals
    • Branding JSON File
    • Home JSON File
    • Navigation JSON File
    • Updating Your Portal
  • AI/ ML Accelerator
    • Data Profiler
      • Introduction to Data Profiler
      • Utilizing Data Profiler Navigator
      • Dataset Level Screen
      • Table Level Screen
      • Column Level Screen
      • Explorer Mode
      • Accessing Data Profiler in ML JupyterLab
    • ML JupyterLab
      • Introduction to ML JupyterLab
      • Launching a ML JupyterLab Job
      • In App Features
      • Getting Started with ML JupyterLab
    • MLflow
      • Introduction to MLflow
      • Getting Started with MLflow
      • Using MLflow Tracking Server
      • Model Registry
      • Using Existing Model
      • Utilizing MLflow in JupyterLab
Powered by GitBook
On this page
  • Registering You Model
  • Register a Model though GUI
  • Register a Model though API
  • Resources

Was this helpful?

Export as PDF
  1. AI/ ML Accelerator
  2. MLflow

Model Registry

PreviousUsing MLflow Tracking ServerNextUsing Existing Model

Last updated 2 months ago

Was this helpful?

AI/ML Accelerator - MLflow is specifically built to track your ML experiments on the DNAnexus platform environment via the ML JupyterLab (another app in the AI/ML Accelerator package) environment. A license is required in order to use the AI/ML Accelerator package. For more information, please contact DNAnexus Sales via .

Registering You Model

Once being logged, a model can be registered by the MLflow Model Registry. For more information on how MLflow Model Registry works, please see . When a model is successfully registered, it will be available on the Models page and have version control.

You can register a model in the Model Registry through both GUI and API.

Register a Model though GUI

In the GUI of the MLflow Tracking Server, follow the below steps to register your MLflow model.

1. In the Experiments section, click on your experiment (e.g. 'TCGA Breast Cancer' as below). Then, select the run (model) that you would like to register.

{alt="Detailed page of an Experiment"}

Detailed page of an Experiment

2. You will be directed to the detailed page of the selected run (model). In this section, select 'Artifacts', and click on 'model'. Then, you will be able to register your run as a new registered model (by defining a new model name) or as a new version of an existing model (by selecting an existing registered model).

{alt="Detailed page of a selected run (model)"}

Detailed page of a selected run (model)

Register a Model though API

Another way to register your run (model) is through the MLflow model flavor or the MLflow Client Tracking API interface. Specifically, you can register a model either during an MLflow experiment run or after completing all your experiment runs. Below is an example of model registration through API.

# Define name of the registered model and assign the run ID
model_name = "tcga_breast_cancer_model" # Assign any name for your registered model
run_id = "xxxx" # ID generated by MLflow once you log a run
# Register the model to the MLflow Model Registry
registered_model = mlflow.register_model(model_uri=f"runs:/{run_id}/model", name=model_name)

run_id can be retrieved through the GUI of MLflow Tracking Server or directly from a session in your notebook via the start_run() method. See the example below:

with mlflow.start_run() as run:
## your ML scripts
run_id = run.info.run_id  # This is your run_id

Resources

To create a support ticket if there are technical issues:

  1. Go to the Help header (same section where Projects and Tools are) inside the platform

  2. Select "Contact Support"

  3. Fill in the Subject and Message to submit a support ticket.

\

Full Documentation
sales@dnanexus.com
MLflow documentation