Skip to content

Commit

Permalink
master docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Jan 4, 2024
1 parent 979f581 commit b32718c
Show file tree
Hide file tree
Showing 62 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion 0.1.0rc0/.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: cb727d83d1c0ab41ff400eadc9261e1d
config: b999516f84a0500005576873aec76ace
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.1.0rc0/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/pages/api/exceptions.doctree
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/pages/install.doctree
Binary file not shown.
Binary file modified 0.1.0rc0/.doctrees/pages/quickstart.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 0.1.1/.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: 8529196b84916442ba9ee13bd38af8e4
config: 0ffe2acad8aa300bb0eeaf98c9830045
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.1.1/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.1.1/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.1.1/.doctrees/pages/api/exceptions.doctree
Binary file not shown.
Binary file modified 0.1.1/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.1.1/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.1.1/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified 0.1.1/.doctrees/pages/install.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 0.2.0/.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: 9d72afc0ef047dbed8bf6396f3727f20
config: 5bcfea966e581089188ee5f06ec3d7e5
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.2.0/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.2.0/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.2.0/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.2.0/.doctrees/pages/api/functional.doctree
Binary file not shown.
Binary file modified 0.2.0/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.2.0/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified 0.2.0/.doctrees/pages/install.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 0.3.0/.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: 08fb4ec530590b64c90f93cf4d09abb7
config: 47a883a76ab86c91f64dd54a4f2ec644
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.3.0/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.3.0/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.3.0/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.3.0/.doctrees/pages/api/functional.doctree
Binary file not shown.
Binary file modified 0.3.0/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.3.0/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified 0.3.0/.doctrees/pages/install.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 0.4.0/.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: f5f6fdcfaa43f7ae3b82a9229622359a
config: b4fa5efc64c1d107287d1c2683875408
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.4.0/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.4.0/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.4.0/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.4.0/.doctrees/pages/api/functional.doctree
Binary file not shown.
Binary file modified 0.4.0/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.4.0/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified 0.4.0/.doctrees/pages/install.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion 0.4.1/.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: c4207ed7960d58f5193d034e933703a4
config: 83ceddfa9dbc3301d6d85b066dd39973
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified 0.4.1/.doctrees/environment.pickle
Binary file not shown.
Binary file modified 0.4.1/.doctrees/index.doctree
Binary file not shown.
Binary file modified 0.4.1/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified 0.4.1/.doctrees/pages/api/functional.doctree
Binary file not shown.
Binary file modified 0.4.1/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified 0.4.1/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified 0.4.1/.doctrees/pages/install.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion master/.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: 056a42a68d370edd8d49b148560d0f09
config: 880e9eb3249a342ca7564a3b42515586
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified master/.doctrees/environment.pickle
Binary file not shown.
Binary file modified master/.doctrees/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/pages/api/factory.doctree
Binary file not shown.
Binary file modified master/.doctrees/pages/api/functional.doctree
Binary file not shown.
Binary file modified master/.doctrees/pages/api/registry.doctree
Binary file not shown.
Binary file modified master/.doctrees/pages/examples.doctree
Binary file not shown.
Binary file modified master/.doctrees/pages/install.doctree
Binary file not shown.
16 changes: 8 additions & 8 deletions master/_modules/hydra_slayer/factory.html
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ <h1>Source code for hydra_slayer.factory</h1><div class="highlight"><pre>

<span class="sd"> Args:</span>
<span class="sd"> factory: factory to create instance from</span>
<span class="sd"> args: \*args to pass to the factory</span>
<span class="sd"> kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> args: positional arguments to be passed into the factory</span>
<span class="sd"> kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> Instance.</span>
Expand Down Expand Up @@ -260,8 +260,8 @@ <h1>Source code for hydra_slayer.factory</h1><div class="highlight"><pre>

<span class="sd"> Args:</span>
<span class="sd"> factory: factory to create instance from</span>
<span class="sd"> args: \*args to pass to the factory</span>
<span class="sd"> kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> args: positional arguments to be passed into the factory</span>
<span class="sd"> kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> Instance.</span>
Expand All @@ -284,8 +284,8 @@ <h1>Source code for hydra_slayer.factory</h1><div class="highlight"><pre>

<span class="sd"> Args:</span>
<span class="sd"> factory: factory to create instance from</span>
<span class="sd"> args: \*args to merge into the factory</span>
<span class="sd"> kwargs: \*\*kwargs to merge into the factory</span>
<span class="sd"> args: positional arguments to be merged into the factory</span>
<span class="sd"> kwargs: keyword arguments to be merged into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> Partial object.</span>
Expand All @@ -310,8 +310,8 @@ <h1>Source code for hydra_slayer.factory</h1><div class="highlight"><pre>

<span class="sd"> Args:</span>
<span class="sd"> factory: factory to create instance from</span>
<span class="sd"> args: \*args to pass to the factory</span>
<span class="sd"> kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> args: positional arguments to be passed into the factory</span>
<span class="sd"> kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> Instance.</span>
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/hydra_slayer/functional.html
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,8 @@ <h1>Source code for hydra_slayer.functional</h1><div class="highlight"><pre>
<span class="sd"> factory_key: key to extract factory name from</span>
<span class="sd"> get_factory_func: function that returns factory by its name.</span>
<span class="sd"> Default: :py:func:`.functional.get_factory`</span>
<span class="sd"> args: \*args to pass to the factory</span>
<span class="sd"> kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> args: positional arguments to be passed into the factory</span>
<span class="sd"> kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> created instance</span>
Expand Down
8 changes: 4 additions & 4 deletions master/_modules/hydra_slayer/registry.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h1>Source code for hydra_slayer.registry</h1><div class="highlight"><pre>
<span class="sd"> factories: more instances</span>
<span class="sd"> name: name to use for the first factory instance,</span>
<span class="sd"> if a single instance is passed</span>
<span class="sd"> named_factories: factory and their names as \*\*kwargs</span>
<span class="sd"> named_factories: factory and their names as keyword arguments</span>

<span class="sd"> Returns:</span>
<span class="sd"> first factory passed</span>
Expand Down Expand Up @@ -365,8 +365,8 @@ <h1>Source code for hydra_slayer.registry</h1><div class="highlight"><pre>
<span class="sd"> Creates instance by calling specified factory with ``instantiate_fn``.</span>

<span class="sd"> Args:</span>
<span class="sd"> *args: \*args to pass to the factory</span>
<span class="sd"> **kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> *args: positional arguments to be passed into the factory</span>
<span class="sd"> **kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> created instance</span>
Expand All @@ -386,7 +386,7 @@ <h1>Source code for hydra_slayer.registry</h1><div class="highlight"><pre>
<span class="sd"> Args:</span>
<span class="sd"> shared_params: params to pass on all levels in case of</span>
<span class="sd"> recursive creation</span>
<span class="sd"> **kwargs: \*\*kwargs to pass to the factory</span>
<span class="sd"> **kwargs: keyword arguments to be passed into the factory</span>

<span class="sd"> Returns:</span>
<span class="sd"> result of calling ``instantiate_fn(factory, **sub_kwargs)``</span>
Expand Down
16 changes: 8 additions & 8 deletions master/pages/api/factory.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ <h1>Factory<a class="headerlink" href="#factory" title="Permalink to this headli
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>factory</strong> – factory to create instance from</p></li>
<li><p><strong>args</strong>*args to pass to the factory</p></li>
<li><p><strong>kwargs</strong>**kwargs to pass to the factory</p></li>
<li><p><strong>args</strong>positional arguments to be passed into the factory</p></li>
<li><p><strong>kwargs</strong>keyword arguments to be passed into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down Expand Up @@ -214,8 +214,8 @@ <h1>Factory<a class="headerlink" href="#factory" title="Permalink to this headli
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>factory</strong> – factory to create instance from</p></li>
<li><p><strong>args</strong>*args to pass to the factory</p></li>
<li><p><strong>kwargs</strong>**kwargs to pass to the factory</p></li>
<li><p><strong>args</strong>positional arguments to be passed into the factory</p></li>
<li><p><strong>kwargs</strong>keyword arguments to be passed into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down Expand Up @@ -263,8 +263,8 @@ <h1>Factory<a class="headerlink" href="#factory" title="Permalink to this headli
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>factory</strong> – factory to create instance from</p></li>
<li><p><strong>args</strong>*args to pass to the factory</p></li>
<li><p><strong>kwargs</strong>**kwargs to pass to the factory</p></li>
<li><p><strong>args</strong>positional arguments to be passed into the factory</p></li>
<li><p><strong>kwargs</strong>keyword arguments to be passed into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down Expand Up @@ -299,8 +299,8 @@ <h1>Factory<a class="headerlink" href="#factory" title="Permalink to this headli
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>factory</strong> – factory to create instance from</p></li>
<li><p><strong>args</strong>*args to merge into the factory</p></li>
<li><p><strong>kwargs</strong>**kwargs to merge into the factory</p></li>
<li><p><strong>args</strong>positional arguments to be merged into the factory</p></li>
<li><p><strong>kwargs</strong>keyword arguments to be merged into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down
8 changes: 4 additions & 4 deletions master/pages/api/registry.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <h1>Registry<a class="headerlink" href="#registry" title="Permalink to this head
<li><p><strong>factories</strong> – more instances</p></li>
<li><p><strong>name</strong> – name to use for the first factory instance,
if a single instance is passed</p></li>
<li><p><strong>named_factories</strong> – factory and their names as **kwargs</p></li>
<li><p><strong>named_factories</strong> – factory and their names as keyword arguments</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down Expand Up @@ -270,7 +270,7 @@ <h1>Registry<a class="headerlink" href="#registry" title="Permalink to this head
<dd class="field-odd"><ul class="simple">
<li><p><strong>shared_params</strong> – params to pass on all levels in case of
recursive creation</p></li>
<li><p><strong>**kwargs</strong>**kwargs to pass to the factory</p></li>
<li><p><strong>**kwargs</strong>keyword arguments to be passed into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand All @@ -292,8 +292,8 @@ <h1>Registry<a class="headerlink" href="#registry" title="Permalink to this head
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>*args</strong>*args to pass to the factory</p></li>
<li><p><strong>**kwargs</strong>**kwargs to pass to the factory</p></li>
<li><p><strong>*args</strong>positional arguments to be passed into the factory</p></li>
<li><p><strong>**kwargs</strong>keyword arguments to be passed into the factory</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down
Loading

0 comments on commit b32718c

Please sign in to comment.