mlflow-client 0.0.1

MLflow REST API client (unofficial)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use crate::client::MlflowClient;
use crate::data::{CreateRunOptions, Experiment, SearchRunsOptions, Timestamp};
use crate::utils::none_if_not_exist;
use crate::{MlflowRun, MlflowRunWriter, Result};

#[derive(Debug, Clone)]
pub struct MlflowExperiment {
    client: MlflowClient,
    data: Experiment,
}

impl MlflowExperiment {
    pub(crate) fn new(client: &MlflowClient, data: Experiment) -> MlflowExperiment {
        MlflowExperiment {
            client: client.clone(),
            data,
        }
    }
    pub fn id(&self) -> &str {
        &self.data.experiment_id
    }
    pub fn name(&self) -> &str {
        &self.data.name
    }
    pub fn data(&self) -> &Experiment {
        &self.data
    }

    pub fn reload(&self) -> Result<Self> {
        Ok(MlflowExperiment::new(
            &self.client,
            self.client.get_experiment(self.id())?.experiment,
        ))
    }

    pub fn delete(&self) -> Result<()> {
        self.client.delete_experiment(self.id())?;
        Ok(())
    }
    pub fn restore(&self) -> Result<()> {
        self.client.restore_experiment(self.id())?;
        Ok(())
    }
    pub fn update(&self, new_name: &str) -> Result<()> {
        self.client.update_experiment(self.id(), new_name)?;
        Ok(())
    }
    pub fn set_tag(&self, key: &str, value: &str) -> Result<()> {
        self.client.set_experiment_tag(self.id(), key, value)?;
        Ok(())
    }

    /// Get all active runs in this experiment.
    pub fn runs(&self) -> Result<Vec<MlflowRun>> {
        self.runs_with(SearchRunsOptions::default())
    }
    pub fn runs_with(&self, options: SearchRunsOptions) -> Result<Vec<MlflowRun>> {
        let mut results = Vec::new();
        let mut page_token = None;
        loop {
            let response = self.client.search_runs(
                &[self.id()],
                options,
                MlflowClient::SEARCH_RUNS_MAX_RESULTS_SUPPORTED,
                page_token.as_deref(),
            )?;
            for run in response.runs {
                results.push(MlflowRun::new(&self.client, run));
            }
            page_token = response.next_page_token;
            if page_token.is_none() {
                break;
            }
        }
        Ok(results)
    }
    pub fn run(&self, id: &str) -> Result<Option<MlflowRun>> {
        none_if_not_exist(self.client.get_run(id), |r| {
            Ok(MlflowRun::new(&self.client, r.run))
        })
    }
    pub fn create_run(&self, name: &str, options: CreateRunOptions) -> Result<MlflowRun> {
        let r = self.client.create_run(self.id(), name, options)?;
        Ok(MlflowRun::new(&self.client, r.run))
    }
    pub fn start_run(&self, name: &str) -> Result<MlflowRunWriter> {
        self.start_run_with(name, CreateRunOptions::default())
    }
    pub fn start_run_with(
        &self,
        name: &str,
        mut options: CreateRunOptions,
    ) -> Result<MlflowRunWriter> {
        if options.start_time.is_none() {
            options.start_time = Some(Timestamp::now());
        }
        Ok(self.create_run(name, options)?.writer())
    }
}