MLflow experiments and runs
Create run
Create a new run within an experiment. A run is usually a single execution of a
machine learning or data ETL pipeline. MLflow uses runs to track :ref:mlflowParam,
:ref:mlflowMetric, and :ref:mlflowRunTag associated with a single execution.
POST
/
api
/
2.0
/
mlflow
/
runs
/
create
cURL
curl --request POST \
--url https://mycluster.domino.tech/api/2.0/mlflow/runs/create \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"user_id": "<string>"
}
'import requests
url = "https://mycluster.domino.tech/api/2.0/mlflow/runs/create"
payload = {
"experiment_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"user_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
run_name: '<string>',
start_time: 123,
tags: [{key: '<string>', value: '<string>'}],
user_id: '<string>'
})
};
fetch('https://mycluster.domino.tech/api/2.0/mlflow/runs/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/2.0/mlflow/runs/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'run_name' => '<string>',
'start_time' => 123,
'tags' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'user_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/2.0/mlflow/runs/create"
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mycluster.domino.tech/api/2.0/mlflow/runs/create")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/2.0/mlflow/runs/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"run": {
"data": {
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"metrics": [
{
"key": "<string>",
"step": "0",
"timestamp": 123,
"value": 123
}
],
"params": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"info": {
"artifact_uri": "<string>",
"experiment_id": "<string>",
"lifecycle_stage": "<string>",
"run_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"status": "RUNNING",
"user_id": "<string>",
"end_time": 123
},
"inputs": {
"dataset_inputs": [
{
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"dataset": {
"name": "<string>",
"digest": "<string>",
"source_type": "<string>",
"source": "<string>",
"schema": "<string>",
"profile": "<string>"
}
}
]
}
}
}{
"error_code": "INTERNAL_ERROR",
"message": "<string>"
}Body
application/json
ID of the associated experiment.
Name of the run.
Unix timestamp in milliseconds of when the run started.
Additional metadata for run.
Show child attributes
Show child attributes
ID of the user executing the run. This field is deprecated as of MLflow 1.0, and will be removed in a future MLflow release. Use 'mlflow.user' tag instead.
Response
Created run
Run metadata (name, start time, etc) and data (metrics, params, and tags).
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://mycluster.domino.tech/api/2.0/mlflow/runs/create \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"user_id": "<string>"
}
'import requests
url = "https://mycluster.domino.tech/api/2.0/mlflow/runs/create"
payload = {
"experiment_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"user_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
run_name: '<string>',
start_time: 123,
tags: [{key: '<string>', value: '<string>'}],
user_id: '<string>'
})
};
fetch('https://mycluster.domino.tech/api/2.0/mlflow/runs/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/2.0/mlflow/runs/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'run_name' => '<string>',
'start_time' => 123,
'tags' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'user_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/2.0/mlflow/runs/create"
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mycluster.domino.tech/api/2.0/mlflow/runs/create")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/2.0/mlflow/runs/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"run_name\": \"<string>\",\n \"start_time\": 123,\n \"tags\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"run": {
"data": {
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"metrics": [
{
"key": "<string>",
"step": "0",
"timestamp": 123,
"value": 123
}
],
"params": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"info": {
"artifact_uri": "<string>",
"experiment_id": "<string>",
"lifecycle_stage": "<string>",
"run_id": "<string>",
"run_name": "<string>",
"start_time": 123,
"status": "RUNNING",
"user_id": "<string>",
"end_time": 123
},
"inputs": {
"dataset_inputs": [
{
"tags": [
{
"key": "<string>",
"value": "<string>"
}
],
"dataset": {
"name": "<string>",
"digest": "<string>",
"source_type": "<string>",
"source": "<string>",
"schema": "<string>",
"profile": "<string>"
}
}
]
}
}
}{
"error_code": "INTERNAL_ERROR",
"message": "<string>"
}