Skip to content

Commit

Permalink
Deploying to gh-pages from @ bba6725 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
richard-rogers committed Oct 2, 2024
1 parent ea35798 commit 4fbbdca
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 2 deletions.
3 changes: 2 additions & 1 deletion _modules/whylogs/api/whylabs/session/session_manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,8 @@ <h1>Source code for whylogs.api.whylabs.session.session_manager</h1><div class="
<span class="sd"> default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.</span>
<span class="sd"> This is a convenience argument so that you don&#39;t have to supply the dataset id every time you upload a profile if</span>
<span class="sd"> you&#39;re only using a single dataset id.</span>

<span class="sd"> upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs</span>
<span class="sd"> from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">reinit</span><span class="p">:</span>
<span class="n">SessionManager</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
Expand Down
2 changes: 2 additions & 0 deletions _sources/api/whylogs/api/whylabs/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,7 @@ Functions
:param default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don't have to supply the dataset id every time you upload a profile if
you're only using a single dataset id.
:param upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.


Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ Attributes
:param default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don't have to supply the dataset id every time you upload a profile if
you're only using a single dataset id.
:param upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.


.. py:function:: get_current_session() -> Optional[whylogs.api.whylabs.session.session.Session]
Expand Down
2 changes: 2 additions & 0 deletions _sources/api/whylogs/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,8 @@ Functions
:param default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don't have to supply the dataset id every time you upload a profile if
you're only using a single dataset id.
:param upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.


.. py:class:: DatasetProfileView(*, columns: Dict[str, whylogs.core.view.column_profile_view.ColumnProfileView], dataset_timestamp: Optional[datetime.datetime], creation_timestamp: Optional[datetime.datetime], metrics: Optional[Dict[str, Any]] = None, metadata: Optional[Dict[str, str]] = None)
Expand Down
2 changes: 2 additions & 0 deletions api/whylogs/api/whylabs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,8 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
<li><p><strong>default_dataset_id</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don’t have to supply the dataset id every time you upload a profile if
you’re only using a single dataset id.</p></li>
<li><p><strong>upload_on_log</strong> – If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.</p></li>
<li><p><strong>config_path</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – </p></li>
<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3.9/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – </p></li>
</ul>
Expand Down
2 changes: 2 additions & 0 deletions api/whylogs/api/whylabs/session/session_manager/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,8 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
<li><p><strong>default_dataset_id</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don’t have to supply the dataset id every time you upload a profile if
you’re only using a single dataset id.</p></li>
<li><p><strong>upload_on_log</strong> – If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.</p></li>
<li><p><strong>config_path</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – </p></li>
<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3.9/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – </p></li>
</ul>
Expand Down
2 changes: 2 additions & 0 deletions api/whylogs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,8 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
<li><p><strong>default_dataset_id</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don’t have to supply the dataset id every time you upload a profile if
you’re only using a single dataset id.</p></li>
<li><p><strong>upload_on_log</strong> – If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.</p></li>
<li><p><strong>config_path</strong> (<em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3.9/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a><em>]</em>) – </p></li>
<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3.9/library/functions.html#bool" title="(in Python v3.9)"><em>bool</em></a>) – </p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 4fbbdca

Please sign in to comment.