Release Checkpoint

Release a checkpoint, making it available for creating new indexes in Marqo Cloud.

---

POST /models/{model_id}/released-checkpoints/{checkpoint_name}

Example: Releasing a checkpoint

PythoncURL

from marqtune.client import Client
from marqtune.enums import ModelType, DatasetType, InstanceType

url = "https://marqtune.marqo.ai"
api_key = "{api_key}"
model_id = "{model_id}"
marqtune_client = Client(url=url, api_key=api_key)
model = marqtune_client.model(model_id)

# Release a checkpoint for the model.
model.release('epoch_1')

# Release a model.
curl -X POST 'https://marqtune.marqo.ai/models/{model_id}/released-checkpoints/{checkpoint_id}' \
     --header 'x-api-key: {api_key}'

Response: 200 Accepted

Successfully released the checkpoint.

{
    "statusCode": 200,
    "body": {
        "modelId": "model_id"
    }
}

Response: 400 (Invalid release checkpoint)

Invalid release checkpoint.

{
    "statusCode": 400,
    "body": {
      "message": "Invalid checkpoint name: {self.released_checkpoint} for model: name={self.model_name}, id={self.model_id}"
    }
}

Response: 400 (Invalid Request)

Request path or method is invalid.

{
    "statusCode": 400,
    "body": {
      "message": "Invalid request method"
    }
}

Response: 401 (Unauthorised)

Unauthorised. Check your API key and try again.

{
  "message": "Unauthorized."
}

Response: 500 (Internal server error)

Internal server error. Check your API key and try again.

{
  "message": "Internal server error."
}