Deploying to gh-pages from @ 878d691 🚀

api_reference.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <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.3 and Furo 2024.05.06 -->
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 -->
         <title>API Reference - rubicon-ml v0.8.2</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=387cc868" />
@@ -1017,6 +1017,31 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶
 <dd><p>Log an experiment leveraging <code class="docutils literal notranslate"><span class="pre">self.schema_</span></code>.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="rubicon_ml.Project.log_xgboost_model">
+<span class="sig-name descname"><span class="pre">log_xgboost_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xgboost_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">xgb.Booster</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</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_xgboost_model" title="Link to this definition">¶</a></dt>
+<dd><p>Log an XGBoost model as a JSON file to this client object.</p>
+<p>Please note that we do not currently support logging directly from the SKLearn interface.</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>xgboost_model: Booster</strong></dt><dd><p>An xgboost model object in the Booster format</p>
+</dd>
+<dt><strong>artifact_name</strong><span class="classifier">str, optional</span></dt><dd><p>The name of the artifact (the exported XGBoost model).</p>
+</dd>
+<dt><strong>log_artifact_kwargs</strong><span class="classifier">Any</span></dt><dd><p>Additional kwargs to be passed directly to <cite>self.log_artifact</cite>.</p>
+</dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>rubicon.client.Artifact</dt><dd><p>The new artifact.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="rubicon_ml.Project.name">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#rubicon_ml.Project.name" title="Link to this definition">¶</a></dt>
@@ -1687,6 +1712,31 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="rubicon_ml.Experiment.log_xgboost_model">
+<span class="sig-name descname"><span class="pre">log_xgboost_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xgboost_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">xgb.Booster</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">log_artifact_kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</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_xgboost_model" title="Link to this definition">¶</a></dt>
+<dd><p>Log an XGBoost model as a JSON file to this client object.</p>
+<p>Please note that we do not currently support logging directly from the SKLearn interface.</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>xgboost_model: Booster</strong></dt><dd><p>An xgboost model object in the Booster format</p>
+</dd>
+<dt><strong>artifact_name</strong><span class="classifier">str, optional</span></dt><dd><p>The name of the artifact (the exported XGBoost model).</p>
+</dd>
+<dt><strong>log_artifact_kwargs</strong><span class="classifier">Any</span></dt><dd><p>Additional kwargs to be passed directly to <cite>self.log_artifact</cite>.</p>
+</dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>rubicon.client.Artifact</dt><dd><p>The new artifact.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="rubicon_ml.Experiment.metric">
 <span class="sig-name descname"><span class="pre">metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rubicon_ml.Experiment.metric" title="Link to this definition">¶</a></dt>
@@ -2600,7 +2650,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.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="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">'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">
@@ -2610,6 +2660,7 @@ <h2>Rubicon<a class="headerlink" href="#rubicon" title="Link to this heading">¶
 * None to disable deseralization and return the raw data.
 * “h2o” to use <cite>h2o.load_model</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>
 </dd>
 <dt><strong>unpickle</strong><span class="classifier">bool, optional</span></dt><dd><p>Flag indicating whether or not to unpickle artifact data.
@@ -4006,6 +4057,7 @@ <h2>sklearn<a class="headerlink" href="#sklearn" title="Link to this heading">¶
 <li><a class="reference internal" href="#rubicon_ml.Project.log_json"><code class="docutils literal notranslate"><span class="pre">Project.log_json()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Project.log_pip_requirements"><code class="docutils literal notranslate"><span class="pre">Project.log_pip_requirements()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Project.log_with_schema"><code class="docutils literal notranslate"><span class="pre">Project.log_with_schema()</span></code></a></li>
+<li><a class="reference internal" href="#rubicon_ml.Project.log_xgboost_model"><code class="docutils literal notranslate"><span class="pre">Project.log_xgboost_model()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Project.name"><code class="docutils literal notranslate"><span class="pre">Project.name</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Project.repositories"><code class="docutils literal notranslate"><span class="pre">Project.repositories</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Project.repository"><code class="docutils literal notranslate"><span class="pre">Project.repository</span></code></a></li>
@@ -4048,6 +4100,7 @@ <h2>sklearn<a class="headerlink" href="#sklearn" title="Link to this heading">¶
 <li><a class="reference internal" href="#rubicon_ml.Experiment.log_metric"><code class="docutils literal notranslate"><span class="pre">Experiment.log_metric()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Experiment.log_parameter"><code class="docutils literal notranslate"><span class="pre">Experiment.log_parameter()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Experiment.log_pip_requirements"><code class="docutils literal notranslate"><span class="pre">Experiment.log_pip_requirements()</span></code></a></li>
+<li><a class="reference internal" href="#rubicon_ml.Experiment.log_xgboost_model"><code class="docutils literal notranslate"><span class="pre">Experiment.log_xgboost_model()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Experiment.metric"><code class="docutils literal notranslate"><span class="pre">Experiment.metric()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Experiment.metrics"><code class="docutils literal notranslate"><span class="pre">Experiment.metrics()</span></code></a></li>
 <li><a class="reference internal" href="#rubicon_ml.Experiment.model_name"><code class="docutils literal notranslate"><span class="pre">Experiment.model_name</span></code></a></li>

contribute-schema.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <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.3 and Furo 2024.05.06 -->
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 -->
         <title>Contribute a schema - rubicon-ml v0.8.2</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=387cc868" />

contributing.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <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.3 and Furo 2024.05.06 -->
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 -->
         <title>Contributing - rubicon-ml v0.8.2</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=387cc868" />

faqs.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="API Reference" href="api_reference.html" /><link rel="prev" title="Glossary" href="glossary.html" />
 
-    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.3 and Furo 2024.05.06 -->
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 -->
         <title>FAQs - rubicon-ml v0.8.2</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=387cc868" />

genindex.html

@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.3 and Furo 2024.05.06 --><title>Index - rubicon-ml v0.8.2</title>
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 --><title>Index - rubicon-ml v0.8.2</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=387cc868" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -642,14 +642,14 @@ <h2>L</h2>
 </li>
         <li><a href="api_reference.html#rubicon_ml.workflow.prefect.log_feature_task">log_feature_task() (in module rubicon_ml.workflow.prefect)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api_reference.html#rubicon_ml.Experiment.log_h2o_model">log_h2o_model() (rubicon_ml.Experiment method)</a>
 
         <ul>
           <li><a href="api_reference.html#rubicon_ml.Project.log_h2o_model">(rubicon_ml.Project method)</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api_reference.html#rubicon_ml.Experiment.log_json">log_json() (rubicon_ml.Experiment method)</a>
 
         <ul>
@@ -674,6 +674,12 @@ <h2>L</h2>
 
         <ul>
           <li><a href="api_reference.html#rubicon_ml.schema.logger.SchemaMixin.log_with_schema">(rubicon_ml.schema.logger.SchemaMixin method)</a>
+</li>
+        </ul></li>
+        <li><a href="api_reference.html#rubicon_ml.Experiment.log_xgboost_model">log_xgboost_model() (rubicon_ml.Experiment method)</a>
+
+        <ul>
+          <li><a href="api_reference.html#rubicon_ml.Project.log_xgboost_model">(rubicon_ml.Project method)</a>
 </li>
         </ul></li>
     </ul></td>

glossary.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="FAQs" href="faqs.html" /><link rel="prev" title="Visualize Logged Dataframes" href="logging-examples/visualizing-logged-dataframes.html" />
 
-    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.3 and Furo 2024.05.06 -->
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2024.05.06 -->
         <title>Glossary - rubicon-ml v0.8.2</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=387cc868" />