> For the complete documentation index, see [llms.txt](https://steven-mi.gitbook.io/huoguoml/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://steven-mi.gitbook.io/huoguoml/huoguoml-basics/huoguoml-model-registry.md).

# HuoguoML Model Registry

Guide for managing your machine learning models

## Introduction

After experimenting, you want to select a model and make it accessible for further use. For this, you can use the HuoguoML Model Registry, which is the central repository for all your models.

## Register Model

Open the HuoguoML dashboard and go to an experiment run. In the upper right corner, you will see a register button if the model experiment has logged model files (for logging model files see [HuoguoML Tracking API](/huoguoml/huoguoml-basics/huoguoml-tracking-api.md#track-model-files)). Click the button and enter the name of your registry or select the name of an existing registry:

![Register a model with the HuoguoML dashboard](https://849124761-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MTlpHUVMZv_LCEvAPvW%2F-McIzxhoO08M8UGYH1CS%2F-McJ13NkHFJMVj1zaeeL%2FScreenshot%202021-06-16%20at%2010.52.26.png?alt=media\&token=83bf7124-cf7c-422d-a28e-ffdc2f9ae643)

On the dashboard, all registries are visible in a single table:

![](https://849124761-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MTlpHUVMZv_LCEvAPvW%2F-McIzxhoO08M8UGYH1CS%2F-McJ2TgTFv89RT54AEvf%2Fmodel-view.png?alt=media\&token=61e4267a-0d9b-480e-aa9a-72fe40a479dd)

Feature of HuoguoML Registry is that each registered model has its own unique version with a stage. A model can be either in stage none, staging or production. In addition, there can be only one model in production and staging. To get a more detailed view of all models within a registry, you can click on the model:

![All models within a model registry](https://849124761-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MTlpHUVMZv_LCEvAPvW%2F-McIzxhoO08M8UGYH1CS%2F-McJ37b7rBR6QXJeGGkE%2Fmodel-detail-view.png?alt=media\&token=916dac08-2a9d-498c-b332-568508d7d106)

To transfer a model to another stage, you must go to a model and click on the `Change Stage` button. You will be forwarded to a new page, where you can select the new stage

## Access Model Registry

The model files can be retrieved using HTTP GET requests. Below are examples that show the available API endpoints.

**Model files by version:**

```python
curl -X 'GET' \
  'http://SERVER_HOST:SERVER_PORT/api/models/MODEL_NAME/MODEL_VERSION' \
  -H 'accept: application/zip' \
  --output model_files.zip
```

**Model files by tag (production or staging):**

```python
curl -X 'GET' \
  'http://SERVER_HOST:SERVER_PORT/api/models/MODEL_NAME?tag=TAG' \
  -H 'accept: application/zip' \
  --output model_files.zip
```

For all endpoints, you will receive a ZIP file containing the logged files under the `model` directory. In the root directory you will find `huoguoml_meta`, which is a YAML file with the details of the source run.