Skip to content

Commit

Permalink
build based on fecf87a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 17, 2024
1 parent 5749f1f commit 757a7db
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-17T14:45:34","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-17T15:09:16","documenter_version":"1.4.1"}}
4 changes: 2 additions & 2 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · MLFlowClient.jl</title><meta name="title" content="Home · MLFlowClient.jl"/><meta property="og:title" content="Home · MLFlowClient.jl"/><meta property="twitter:title" content="Home · 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."/><meta property="og:url" content="https://juliaai.github.io/MLFlowClient.jl/"/><meta property="twitter:url" content="https://juliaai.github.io/MLFlowClient.jl/"/><link rel="canonical" href="https://juliaai.github.io/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/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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="tutorial/">Tutorial</a></li><li><a class="tocitem" href="reference/">Reference</a></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 class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaAI.jl/blob/main/docs/src/index.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="MLFlowClient"><a class="docs-heading-anchor" href="#MLFlowClient">MLFlowClient</a><a id="MLFlowClient-1"></a><a class="docs-heading-anchor-permalink" href="#MLFlowClient" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLFlowClient.MLFlowClient" href="#MLFlowClient.MLFlowClient"><code>MLFlowClient.MLFlowClient</code></a> — <span class="docstring-category">Module</span></header><section><div><pre><code class="language-julia hljs">MLFlowClient</code></pre><p><a href="https://github.com/JuliaAI.jl">MLFlowClient</a> is a <a href="https://julialang.org/">Julia</a> package for working with <a href="https://mlflow.org/">MLFlow</a> using the REST <a href="https://www.mlflow.org/docs/latest/rest-api.html">API v2.0</a>.</p><p><code>MLFlowClient</code> allows you to create and manage <code>MLFlow</code> experiments, runs, and log metrics and artifacts. If you are not familiar with <code>MLFlow</code> and its concepts, please refer to <a href="https://mlflow.org/docs/latest/index.html">MLFlow documentation</a>.</p><p><strong>Limitations</strong></p><ul><li>no authentication support.</li><li>when storing artifacts, the assumption is that MLFlow and this library run on the same server. Artifacts are stored using plain filesystem operations. Therefore, <code>/mlruns</code> or the specified <code>artifact_location</code> must be accessible to both the MLFlow server (read), and this library (write).</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI.jl/blob/b98cb57e8fc717f67c9437d00a69afc89530b870/src/MLFlowClient.jl#L1-L12">source</a></section></article><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>To install <a href="https://github.com/JuliaAI/MLFlowClient.jl">MLFlowClient</a>, start a <code>julia</code> session and run the following:</p><pre><code class="language-julia-repl hljs">julia&gt; import Pkg
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · MLFlowClient.jl</title><meta name="title" content="Home · MLFlowClient.jl"/><meta property="og:title" content="Home · MLFlowClient.jl"/><meta property="twitter:title" content="Home · 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."/><meta property="og:url" content="https://juliaai.github.io/MLFlowClient.jl/"/><meta property="twitter:url" content="https://juliaai.github.io/MLFlowClient.jl/"/><link rel="canonical" href="https://juliaai.github.io/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/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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="tutorial/">Tutorial</a></li><li><a class="tocitem" href="reference/">Reference</a></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 class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaAI.jl/blob/main/docs/src/index.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="MLFlowClient"><a class="docs-heading-anchor" href="#MLFlowClient">MLFlowClient</a><a id="MLFlowClient-1"></a><a class="docs-heading-anchor-permalink" href="#MLFlowClient" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLFlowClient.MLFlowClient" href="#MLFlowClient.MLFlowClient"><code>MLFlowClient.MLFlowClient</code></a> — <span class="docstring-category">Module</span></header><section><div><pre><code class="language-julia hljs">MLFlowClient</code></pre><p><a href="https://github.com/JuliaAI.jl">MLFlowClient</a> is a <a href="https://julialang.org/">Julia</a> package for working with <a href="https://mlflow.org/">MLFlow</a> using the REST <a href="https://www.mlflow.org/docs/latest/rest-api.html">API v2.0</a>.</p><p><code>MLFlowClient</code> allows you to create and manage <code>MLFlow</code> experiments, runs, and log metrics and artifacts. If you are not familiar with <code>MLFlow</code> and its concepts, please refer to <a href="https://mlflow.org/docs/latest/index.html">MLFlow documentation</a>.</p><p><strong>Limitations</strong></p><ul><li>no authentication support.</li><li>when storing artifacts, the assumption is that MLFlow and this library run on the same server. Artifacts are stored using plain filesystem operations. Therefore, <code>/mlruns</code> or the specified <code>artifact_location</code> must be accessible to both the MLFlow server (read), and this library (write).</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAI.jl/blob/fecf87a28873f5fe68f6d57e802a50adfc67fe6b/src/MLFlowClient.jl#L1-L12">source</a></section></article><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>To install <a href="https://github.com/JuliaAI/MLFlowClient.jl">MLFlowClient</a>, start a <code>julia</code> session and run the following:</p><pre><code class="language-julia-repl hljs">julia&gt; import Pkg

julia&gt; Pkg.add(&quot;MLFlowClient&quot;)</code></pre><p>or simply:</p><pre><code class="language-julia-repl hljs">]add MLFlowClient</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 14:45">Friday 17 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; Pkg.add(&quot;MLFlowClient&quot;)</code></pre><p>or simply:</p><pre><code class="language-julia-repl hljs">]add MLFlowClient</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 17 May 2024 15:09">Friday 17 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 757a7db

Please sign in to comment.