Skip to content

Commit

Permalink
Deploying to gh-pages from @ 39743e9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanSoley committed Oct 1, 2024
1 parent 5805155 commit bd01dff
Show file tree
Hide file tree
Showing 39 changed files with 121 additions and 114 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 478ca16caa7a7948a23f1906ede9830d
config: 4ba53dfeee1f301875baebfea29eef66
tags: 645f666f9bcd5a90fca523b33c5a78b7
21 changes: 14 additions & 7 deletions api_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Representing model metadata with a schema" href="schema-representation.html" /><link rel="prev" title="FAQs" href="faqs.html" />

<link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>API Reference - rubicon-ml v0.10.0</title>
<title>API Reference - rubicon-ml v0.10.1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -168,7 +168,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.0</div></div></a>
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.1</div></div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand Down Expand Up @@ -196,7 +196,7 @@
<img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
</div>

<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.0</div></span>
<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.1</div></span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -933,7 +933,7 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶

<dl class="py method">
<dt class="sig sig-object py" id="rubicon_ml.Project.log_h2o_model">
<span class="sig-name descname"><span class="pre">log_h2o_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h2o_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">artifact_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_cross_validation_predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rubicon_ml.Artifact" title="rubicon_ml.Artifact"><span class="pre">Artifact</span></a></span></span><a class="headerlink" href="#rubicon_ml.Project.log_h2o_model" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">log_h2o_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h2o_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">artifact_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_cross_validation_predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_mojo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rubicon_ml.Artifact" title="rubicon_ml.Artifact"><span class="pre">Artifact</span></a></span></span><a class="headerlink" href="#rubicon_ml.Project.log_h2o_model" title="Link to this definition"></a></dt>
<dd><p>Log an <cite>h2o</cite> model as an artifact using <cite>h2o.save_model</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -944,6 +944,9 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶
</dd>
<dt><strong>export_cross_validation_predictions: bool, optional (default False)</strong></dt><dd><p>Passed directly to <cite>h2o.save_model</cite>.</p>
</dd>
<dt><strong>use_mojo: bool, optional (default False)</strong></dt><dd><p>Whether to log the model in MOJO format. If False, the model will be
logged in binary format.</p>
</dd>
<dt><strong>log_artifact_kwargs</strong><span class="classifier">dict</span></dt><dd><p>Additional kwargs to be passed directly to <cite>self.log_artifact</cite>.</p>
</dd>
</dl>
Expand Down Expand Up @@ -1565,7 +1568,7 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶

<dl class="py method">
<dt class="sig sig-object py" id="rubicon_ml.Experiment.log_h2o_model">
<span class="sig-name descname"><span class="pre">log_h2o_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h2o_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">artifact_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_cross_validation_predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rubicon_ml.Artifact" title="rubicon_ml.Artifact"><span class="pre">Artifact</span></a></span></span><a class="headerlink" href="#rubicon_ml.Experiment.log_h2o_model" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">log_h2o_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h2o_model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">artifact_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_cross_validation_predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_mojo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#rubicon_ml.Artifact" title="rubicon_ml.Artifact"><span class="pre">Artifact</span></a></span></span><a class="headerlink" href="#rubicon_ml.Experiment.log_h2o_model" title="Link to this definition"></a></dt>
<dd><p>Log an <cite>h2o</cite> model as an artifact using <cite>h2o.save_model</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -1576,6 +1579,9 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶
</dd>
<dt><strong>export_cross_validation_predictions: bool, optional (default False)</strong></dt><dd><p>Passed directly to <cite>h2o.save_model</cite>.</p>
</dd>
<dt><strong>use_mojo: bool, optional (default False)</strong></dt><dd><p>Whether to log the model in MOJO format. If False, the model will be
logged in binary format.</p>
</dd>
<dt><strong>log_artifact_kwargs</strong><span class="classifier">dict</span></dt><dd><p>Additional kwargs to be passed directly to <cite>self.log_artifact</cite>.</p>
</dd>
</dl>
Expand Down Expand Up @@ -2637,15 +2643,16 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶

<dl class="py method">
<dt class="sig sig-object py" id="rubicon_ml.Artifact.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deserialize</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'h2o'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'pickle'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'xgboost'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unpickle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rubicon_ml.Artifact.get_data" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deserialize</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'h2o'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'h2o_binary'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'h2o_mojo'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'pickle'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'xgboost'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unpickle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rubicon_ml.Artifact.get_data" title="Link to this definition"></a></dt>
<dd><p>Loads the data associated with this artifact and
unpickles if needed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>deseralize</strong><span class="classifier">str, optional</span></dt><dd><p>Method to use to deseralize this artifact’s data.
* None to disable deseralization and return the raw data.
* “h2o” to use <cite>h2o.load_model</cite> to load the data.
* “h2o” or “h2o_binary” to use <cite>h2o.load_model</cite> to load the data.
* “h2o_mojo” to use <cite>h2o.import_mojo</cite> to load the data.
* “pickle” to use pickles to load the data.
* “xgboost” to use xgboost’s JSON loader to load the data as a fitted model.
Defaults to None.</p>
Expand Down
6 changes: 3 additions & 3 deletions contribute-schema.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Contributing" href="contributing.html" />

<link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>Contribute a schema - rubicon-ml v0.10.0</title>
<title>Contribute a schema - rubicon-ml v0.10.1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -168,7 +168,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.0</div></div></a>
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.1</div></div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand Down Expand Up @@ -196,7 +196,7 @@
<img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
</div>

<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.0</div></span>
<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.1</div></span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
6 changes: 3 additions & 3 deletions contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contribute a schema" href="contribute-schema.html" /><link rel="prev" title="Representing model metadata with a schema" href="schema-representation.html" />

<link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>Contributing - rubicon-ml v0.10.0</title>
<title>Contributing - rubicon-ml v0.10.1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -168,7 +168,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.0</div></div></a>
<a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.10.1</div></div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand Down Expand Up @@ -196,7 +196,7 @@
<img class="sidebar-logo only-dark" src="_static/images/rubicon_ml_logo_only.svg" alt="Dark Logo"/>
</div>

<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.0</div></span>
<span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.10.1</div></span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
Loading

0 comments on commit bd01dff

Please sign in to comment.