Deploying to gh-pages from @ 32d1a83 🚀

capitalone · Sep 12, 2024 · 7c3a075 · 7c3a075
1 parent 82555cc
commit 7c3a075
Show file tree

Hide file tree

Showing 41 changed files with 263 additions and 152 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -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: 55806efb6b65e83c8475a3374597bdcd
+config: e3827707aea91fa5d12f331a838b3c0a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/integrations/integration-prefect-workflows.ipynb.txt b/_sources/integrations/integration-prefect-workflows.ipynb.txt
@@ -29,8 +29,7 @@
     "\n",
     "### Setting up a simple flow\n",
     "\n",
-    "Now we can get started! Creating Prefect **tasks** is easy enough on its own, but we've added\n",
-    "some simple ones to the ``rubicon_ml`` library."
+    "Now we can get started! Let's create some simple Prefect **tasks** for the core ``rubcion_ml`` loggers."
    ]
   },
   {
@@ -39,15 +38,56 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from rubicon_ml.workflow.prefect import (\n",
-    "    get_or_create_project_task,\n",
-    "    create_experiment_task,\n",
-    "    log_artifact_task,\n",
-    "    log_dataframe_task,\n",
-    "    log_feature_task,\n",
-    "    log_metric_task,\n",
-    "    log_parameter_task,\n",
-    ")"
+    "\n",
+    "from prefect import task\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def get_or_create_project_task(\n",
+    "    persistence, root_dir, project_name, auto_git_enabled=False, storage_options={}, **kwargs\n",
+    "):\n",
+    "    from rubicon_ml import Rubicon\n",
+    "\n",
+    "\n",
+    "    rubicon = Rubicon(\n",
+    "        persistence=persistence,\n",
+    "        root_dir=root_dir,\n",
+    "        auto_git_enabled=auto_git_enabled,\n",
+    "        **storage_options,\n",
+    "    )\n",
+    "    project = rubicon.get_or_create_project(project_name, **kwargs)\n",
+    "\n",
+    "    return project\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def create_experiment_task(project, **kwargs):\n",
+    "    return project.log_experiment(**kwargs)\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def log_artifact_task(parent, **kwargs):\n",
+    "    return parent.log_artifact(**kwargs)\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def log_dataframe_task(parent, df, **kwargs):\n",
+    "    return parent.log_dataframe(df, **kwargs)\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def log_feature_task(experiment, feature_name, **kwargs):\n",
+    "    return experiment.log_feature(feature_name, **kwargs)\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def log_metric_task(experiment, metric_name, metric_value, **kwargs):\n",
+    "    return experiment.log_metric(metric_name, metric_value, **kwargs)\n",
+    "\n",
+    "\n",
+    "@task\n",
+    "def log_parameter_task(experiment, parameter_name, parameter_value, **kwargs):\n",
+    "    return experiment.log_parameter(parameter_name, parameter_value, **kwargs)"
    ]
   },
   {
@@ -65,9 +105,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from prefect import task\n",
-    "\n",
-    "\n",
     "@task\n",
     "def load_data():\n",
     "    from sklearn.datasets import load_wine\n",

diff --git a/api_reference.html b/api_reference.html
@@ -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.9.0</title>
+        <title>API Reference - rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/contribute-schema.html b/contribute-schema.html
@@ -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.9.0</title>
+        <title>Contribute a schema - rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/contributing.html b/contributing.html
@@ -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.9.0</title>
+        <title>Contributing - rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/faqs.html b/faqs.html
@@ -6,7 +6,7 @@
 <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.7 and Furo 2024.08.06 -->
-        <title>FAQs - rubicon-ml v0.9.0</title>
+        <title>FAQs - rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/genindex.html b/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.7 and Furo 2024.08.06 --><title>Index - rubicon-ml v0.9.0</title>
+    <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 --><title>Index - rubicon-ml v0.9.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" />
@@ -166,7 +166,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -194,7 +194,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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/glossary.html b/glossary.html
@@ -6,7 +6,7 @@
 <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.7 and Furo 2024.08.06 -->
-        <title>Glossary - rubicon-ml v0.9.0</title>
+        <title>Glossary - rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Logging Experiments" href="quick-look/logging-experiments.html" />
 
     <link rel="shortcut icon" href="_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>rubicon-ml v0.9.0</title>
+        <title>rubicon-ml v0.9.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" />
@@ -168,7 +168,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="#"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="#"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">

diff --git a/integrations/integration-git.html b/integrations/integration-git.html
@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Integrate with Prefect" href="integration-prefect-workflows.html" /><link rel="prev" title="Distinguish Failed Experiments" href="../logging-examples/logging-experiment-failures.html" />
 
     <link rel="shortcut icon" href="../_static/rubicon_ml_logo_favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
-        <title>Integrate with Git - rubicon-ml v0.9.0</title>
+        <title>Integrate with Git - rubicon-ml v0.9.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" />
@@ -169,7 +169,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.0</div></div></a>
+      <a href="../index.html"><div class="brand"><div class='version'>rubicon-ml v0.9.1</div></div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -197,7 +197,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.9.0</div></span>
+  <span class="sidebar-brand-text"><div class='version'>rubicon-ml v0.9.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">