Deploying to gh-pages from @ d7d01a2 🚀

main/.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: 8606c49b9da37781c5ceb0fa8d3085da
+config: 9abcd3aa288ed3b05647c635dbb186a4
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

main/404.html

@@ -11,7 +11,7 @@
 <link rel="index" title="Index" href="/genindex/" /><link rel="search" title="Search" href="/search/" />
         <link rel="canonical" href="https://minari.farama.org/404.html" />
 
-    <link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>404 - Page Not Found - Minari Documentation</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=3e7f4c72" />
@@ -230,6 +230,7 @@
 <li class="toctree-l2"><a class="reference internal" href="/api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="/api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="/api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="/api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

main/README/index.html

@@ -11,7 +11,7 @@
 <link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" />
         <link rel="canonical" href="https://minari.farama.org/README.html" />
 
-    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>Minari documentation - Minari Documentation</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=3e7f4c72" />
@@ -230,6 +230,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

main/_modules/index.html

@@ -10,7 +10,7 @@
     <meta property="og:url" content="https://minari.farama.org/_modules/index.html" /><meta property="og:image" content="https://minari.farama.org/_static/img/robotics-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" />
         <link rel="canonical" href="https://minari.farama.org/_modules/index.html" />
 
-    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>Overview: module code - Minari Documentation</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=3e7f4c72" />
@@ -229,6 +229,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
@@ -369,6 +370,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="minari/dataset/minari_dataset/">minari.dataset.minari_dataset</a></li>
 <li><a href="minari/dataset/minari_storage/">minari.dataset.minari_storage</a></li>
 <li><a href="minari/dataset/step_data/">minari.dataset.step_data</a></li>
+<li><a href="minari/namespace/">minari.namespace</a></li>
 <li><a href="minari/storage/hosting/">minari.storage.hosting</a></li>
 <li><a href="minari/storage/local/">minari.storage.local</a></li>
 <li><a href="minari/utils/">minari.utils</a></li>

main/_modules/minari/data_collector/callbacks/episode_metadata/index.html

@@ -10,7 +10,7 @@
     <meta property="og:url" content="https://minari.farama.org/_modules/minari/data_collector/callbacks/episode_metadata.html" /><meta property="og:image" content="https://minari.farama.org/_static/img/robotics-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../../../genindex/" /><link rel="search" title="Search" href="../../../../../search/" />
         <link rel="canonical" href="https://minari.farama.org/_modules/minari/data_collector/callbacks/episode_metadata.html" />
 
-    <link rel="shortcut icon" href="../../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>minari.data_collector.callbacks.episode_metadata - Minari Documentation</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=3e7f4c72" />
@@ -229,6 +229,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../../../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

main/_modules/minari/data_collector/callbacks/step_callback/index.html

@@ -10,7 +10,7 @@
     <meta property="og:url" content="https://minari.farama.org/_modules/minari/data_collector/callbacks/step_callback.html" /><meta property="og:image" content="https://minari.farama.org/_static/img/robotics-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../../../genindex/" /><link rel="search" title="Search" href="../../../../../search/" />
         <link rel="canonical" href="https://minari.farama.org/_modules/minari/data_collector/callbacks/step_callback.html" />
 
-    <link rel="shortcut icon" href="../../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>minari.data_collector.callbacks.step_callback - Minari Documentation</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=3e7f4c72" />
@@ -229,6 +229,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../../../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>

main/_modules/minari/data_collector/data_collector/index.html

@@ -10,7 +10,7 @@
     <meta property="og:url" content="https://minari.farama.org/_modules/minari/data_collector/data_collector.html" /><meta property="og:image" content="https://minari.farama.org/_static/img/robotics-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../../genindex/" /><link rel="search" title="Search" href="../../../../search/" />
         <link rel="canonical" href="https://minari.farama.org/_modules/minari/data_collector/data_collector.html" />
 
-    <link rel="shortcut icon" href="../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>minari.data_collector.data_collector - Minari Documentation</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=3e7f4c72" />
@@ -229,6 +229,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
@@ -378,8 +379,9 @@ <h1>Source code for minari.data_collector.data_collector</h1><div class="highlig
 
 <span class="kn">from</span> <span class="nn">minari.data_collector.callbacks</span> <span class="kn">import</span> <span class="n">EpisodeMetadataCallback</span><span class="p">,</span> <span class="n">StepDataCallback</span>
 <span class="kn">from</span> <span class="nn">minari.data_collector.episode_buffer</span> <span class="kn">import</span> <span class="n">EpisodeBuffer</span>
-<span class="kn">from</span> <span class="nn">minari.dataset.minari_dataset</span> <span class="kn">import</span> <span class="n">MinariDataset</span>
+<span class="kn">from</span> <span class="nn">minari.dataset.minari_dataset</span> <span class="kn">import</span> <span class="n">MinariDataset</span><span class="p">,</span> <span class="n">parse_dataset_id</span>
 <span class="kn">from</span> <span class="nn">minari.dataset.minari_storage</span> <span class="kn">import</span> <span class="n">MinariStorage</span>
+<span class="kn">from</span> <span class="nn">minari.namespace</span> <span class="kn">import</span> <span class="n">create_namespace</span><span class="p">,</span> <span class="n">list_local_namespaces</span>
 <span class="kn">from</span> <span class="nn">minari.utils</span> <span class="kn">import</span> <span class="n">_generate_dataset_metadata</span><span class="p">,</span> <span class="n">_generate_dataset_path</span>
 
 
@@ -411,7 +413,7 @@ <h1>Source code for minari.data_collector.data_collector</h1><div class="highlig
 <span class="sd">            if terminated or truncated:</span>
 <span class="sd">                env.reset()</span>
 
-<span class="sd">        dataset = env.create_dataset(dataset_id=&quot;env_name-dataset_name-v(version)&quot;, **kwargs)</span>
+<span class="sd">        dataset = env.create_dataset(dataset_id=&quot;optional_namespace/env_name-dataset_name-v(version)&quot;, **kwargs)</span>
 
 <span class="sd">    Some of the characteristics of this wrapper:</span>
 
@@ -606,7 +608,7 @@ <h1>Source code for minari.data_collector.data_collector</h1><div class="highlig
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Create a Minari dataset using the data collected from stepping with a Gymnasium environment wrapped with a `DataCollector` Minari wrapper.</span>
 
 <span class="sd">        The ``dataset_id`` parameter corresponds to the name of the dataset, with the syntax as follows:</span>
-<span class="sd">        ``(env_name-)(dataset_name)(-v(version))`` where ``env_name`` identifies the name of the environment used to generate the dataset ``dataset_name``.</span>
+<span class="sd">        ``(namespace/)(env_name-)(dataset_name)(-v(version))`` where ``env_name`` identifies the name of the environment used to generate the dataset ``dataset_name``. The `namespace` (and leading forward slash) is optional.</span>
 <span class="sd">        This ``dataset_id`` is used to load the Minari datasets with :meth:`minari.load_dataset`.</span>
 
 <span class="sd">        Args:</span>
@@ -627,6 +629,11 @@ <h1>Source code for minari.data_collector.data_collector</h1><div class="highlig
 <span class="sd">        Returns:</span>
 <span class="sd">            MinariDataset</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">namespace</span> <span class="o">=</span> <span class="n">parse_dataset_id</span><span class="p">(</span><span class="n">dataset_id</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+
+        <span class="k">if</span> <span class="n">namespace</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">namespace</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">list_local_namespaces</span><span class="p">():</span>
+            <span class="n">create_namespace</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
+
         <span class="n">dataset_path</span> <span class="o">=</span> <span class="n">_generate_dataset_path</span><span class="p">(</span><span class="n">dataset_id</span><span class="p">)</span>
         <span class="n">metadata</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">_generate_dataset_metadata</span><span class="p">(</span>
             <span class="n">dataset_id</span><span class="p">,</span>

main/_modules/minari/data_collector/episode_buffer/index.html

@@ -10,7 +10,7 @@
     <meta property="og:url" content="https://minari.farama.org/_modules/minari/data_collector/episode_buffer.html" /><meta property="og:image" content="https://minari.farama.org/_static/img/robotics-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../../genindex/" /><link rel="search" title="Search" href="../../../../search/" />
         <link rel="canonical" href="https://minari.farama.org/_modules/minari/data_collector/episode_buffer.html" />
 
-    <link rel="shortcut icon" href="../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
+    <link rel="shortcut icon" href="../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.5 and Furo 2023.08.19.dev1 -->
         <title>minari.data_collector.episode_buffer - Minari Documentation</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=3e7f4c72" />
@@ -229,6 +229,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/minari_storage/">MinariStorage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/episode_data/">EpisodeData</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../../../api/minari_dataset/step_data/">StepData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../../api/namespace/namespace/">Namespace</a></li>
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../api/data_collector/">DataCollector</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of DataCollector</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>