Skip to content

Commit 094d117

Browse files
author
Documenter.jl
committed
build based on a7e9fb0
1 parent 3d4b82d commit 094d117

16 files changed

Lines changed: 63 additions & 63 deletions

File tree

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-17T01:49:22","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-17T02:41:08","julia_version":"1.12.6"}}

dev/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/reference/artifact/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/reference/experiment/index.html

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

dev/reference/gateway/index.html

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

dev/reference/logger/index.html

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

dev/reference/misc/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<!DOCTYPE html>
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Miscellaneous operations · MLFlowClient.jl</title><meta name="title" content="Miscellaneous operations · MLFlowClient.jl"/><meta property="og:title" content="Miscellaneous operations · MLFlowClient.jl"/><meta property="twitter:title" content="Miscellaneous operations · MLFlowClient.jl"/><meta name="description" content="Documentation for MLFlowClient.jl."/><meta property="og:description" content="Documentation for MLFlowClient.jl."/><meta property="twitter:description" content="Documentation for MLFlowClient.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">MLFlowClient.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><a class="tocitem" href="../../tutorial/">Tutorial</a></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../types/">Types</a></li><li><a class="tocitem" href="../artifact/">Artifact operations</a></li><li><a class="tocitem" href="../experiment/">Experiment operations</a></li><li><a class="tocitem" href="../logger/">Logging operations</a></li><li class="is-active"><a class="tocitem" href>Miscellaneous operations</a></li><li><a class="tocitem" href="../run/">Run operations</a></li><li><a class="tocitem" href="../registered_model/">Registered model operations</a></li><li><a class="tocitem" href="../model_version/">Model version operations</a></li><li><a class="tocitem" href="../user/">User operations</a></li><li><a class="tocitem" href="../webhook/">Webhook operations</a></li><li><a class="tocitem" href="../scorer/">Scorer operations</a></li><li><a class="tocitem" href="../gateway/">Gateway operations</a></li><li><a class="tocitem" href="../prompt_optimization/">Prompt optimization operations</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Reference</a></li><li class="is-active"><a href>Miscellaneous operations</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Miscellaneous operations</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaAI/MLFlowClient.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaAI/MLFlowClient.jl/blob/main/docs/src/reference/misc.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Miscellaneous-operations"><a class="docs-heading-anchor" href="#Miscellaneous-operations">Miscellaneous operations</a><a id="Miscellaneous-operations-1"></a><a class="docs-heading-anchor-permalink" href="#Miscellaneous-operations" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="MLFlowClient.getmetrichistory"><a class="docstring-binding" href="#MLFlowClient.getmetrichistory"><code>MLFlowClient.getmetrichistory</code></a><span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">getmetrichistory(instance::MLFlow, run_id::String, metric_key::String;
3-
page_token::String=&quot;&quot;, max_results::Union{Int64, Missing}=missing)</code></pre><p>Get a list of all values for the specified <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> for a given <a href="../types/#MLFlowClient.Run"><code>Run</code></a>.</p><p><strong>Arguments</strong></p><ul><li><code>instance</code>: <a href="../types/#MLFlowClient.MLFlow"><code>MLFlow</code></a> configuration.</li><li><code>run_id</code>: ID of the <a href="../types/#MLFlowClient.Run"><code>Run</code></a> from which to fetch <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> values.</li><li><code>metric_key</code>: Name of the <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> to fetch.</li><li><code>page_token</code>: Token indicating the page of <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> history to fetch.</li><li><code>max_results</code>: Maximum number of logged instances of a <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> for a <a href="../types/#MLFlowClient.Run"><code>Run</code></a> to return per call. Defaults to 50.</li></ul><p><strong>Returns</strong></p><ul><li>A list of all historical values for the specified <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> in the specified <a href="../types/#MLFlowClient.Run"><code>Run</code></a>.</li><li>The next page token if there are more results.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLFlowClient.jl/blob/516dc7760c13da07057fdd8c57cf81219cf1d7bf/src/services/misc.jl#L1-L19">source</a></section></details></article><article><details class="docstring" open="true"><summary id="MLFlowClient.refresh"><a class="docstring-binding" href="#MLFlowClient.refresh"><code>MLFlowClient.refresh</code></a><span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">refresh(instance::MLFlow, run::Run)
4-
refresh(instance::MLFlow, experiment::Experiment)</code></pre><p>Get the latest metadata for a <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a>.</p><p><strong>Arguments</strong></p><ul><li><code>instance</code>: <a href="../types/#MLFlowClient.MLFlow"><code>MLFlow</code></a> configuration.</li><li><code>run</code> or <code>experiment</code>: <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a> to refresh.</li></ul><p><strong>Returns</strong></p><p>An instance of type <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLFlowClient.jl/blob/516dc7760c13da07057fdd8c57cf81219cf1d7bf/src/services/misc.jl#L41-L53">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../logger/">« Logging operations</a><a class="docs-footer-nextpage" href="../run/">Run operations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 17 April 2026 01:49">Friday 17 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
3+
page_token::String=&quot;&quot;, max_results::Union{Int64, Missing}=missing)</code></pre><p>Get a list of all values for the specified <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> for a given <a href="../types/#MLFlowClient.Run"><code>Run</code></a>.</p><p><strong>Arguments</strong></p><ul><li><code>instance</code>: <a href="../types/#MLFlowClient.MLFlow"><code>MLFlow</code></a> configuration.</li><li><code>run_id</code>: ID of the <a href="../types/#MLFlowClient.Run"><code>Run</code></a> from which to fetch <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> values.</li><li><code>metric_key</code>: Name of the <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> to fetch.</li><li><code>page_token</code>: Token indicating the page of <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> history to fetch.</li><li><code>max_results</code>: Maximum number of logged instances of a <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> for a <a href="../types/#MLFlowClient.Run"><code>Run</code></a> to return per call. Defaults to 50.</li></ul><p><strong>Returns</strong></p><ul><li>A list of all historical values for the specified <a href="../types/#MLFlowClient.Metric"><code>Metric</code></a> in the specified <a href="../types/#MLFlowClient.Run"><code>Run</code></a>.</li><li>The next page token if there are more results.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLFlowClient.jl/blob/a7e9fb08097191de659c613e89e9d5c64abd9eeb/src/services/misc.jl#L1-L19">source</a></section></details></article><article><details class="docstring" open="true"><summary id="MLFlowClient.refresh"><a class="docstring-binding" href="#MLFlowClient.refresh"><code>MLFlowClient.refresh</code></a><span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">refresh(instance::MLFlow, run::Run)
4+
refresh(instance::MLFlow, experiment::Experiment)</code></pre><p>Get the latest metadata for a <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a>.</p><p><strong>Arguments</strong></p><ul><li><code>instance</code>: <a href="../types/#MLFlowClient.MLFlow"><code>MLFlow</code></a> configuration.</li><li><code>run</code> or <code>experiment</code>: <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a> to refresh.</li></ul><p><strong>Returns</strong></p><p>An instance of type <a href="../types/#MLFlowClient.Run"><code>Run</code></a> or <a href="../types/#MLFlowClient.Experiment"><code>Experiment</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI/MLFlowClient.jl/blob/a7e9fb08097191de659c613e89e9d5c64abd9eeb/src/services/misc.jl#L41-L53">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../logger/">« Logging operations</a><a class="docs-footer-nextpage" href="../run/">Run operations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 17 April 2026 02:41">Friday 17 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)