Skip to content

Commit

Permalink
Deployed 56d8569 to 3.5.0-RC5 with MkDocs 1.3.0 and mike 2.1.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike committed Jan 18, 2024
1 parent 3a6c9a4 commit 9277f6f
Show file tree
Hide file tree
Showing 346 changed files with 725 additions and 725 deletions.
36 changes: 18 additions & 18 deletions 3.5.0-RC5/generated/api/query_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1422,7 +1422,7 @@ <h1 id="query">Query<a class="headerlink" href="#query" title="Permanent link">#
Users will never construct a Query object using the constructor of the class.
For this reason we do not provide the full documentation of the class here.</p>
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h2>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L543">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L550">[source]</a></span></p>
<h3 id="append_feature">append_feature<a class="headerlink" href="#append_feature" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">append_feature</span><span class="p">(</span><span class="n">feature</span><span class="p">)</span>
</code></pre></div>
Expand All @@ -1432,7 +1432,7 @@ <h3 id="append_feature">append_feature<a class="headerlink" href="#append_featur
<li><strong>feature</strong>: <code>[str, Feature]</code>. Name of the feature to append to the query.</li>
</ul>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L245">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L252">[source]</a></span></p>
<h3 id="as_of">as_of<a class="headerlink" href="#as_of" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">as_of</span><span class="p">(</span><span class="n">wallclock_time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exclude_until</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</code></pre></div>
Expand Down Expand Up @@ -1507,7 +1507,7 @@ <h3 id="as_of">as_of<a class="headerlink" href="#as_of" title="Permanent link">#
<p><strong>Returns</strong></p>
<p><code>Query</code>. The query object with the applied time travel condition.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L351">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L358">[source]</a></span></p>
<h3 id="filter">filter<a class="headerlink" href="#filter" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
</code></pre></div>
Expand Down Expand Up @@ -1560,12 +1560,12 @@ <h3 id="filter">filter<a class="headerlink" href="#filter" title="Permanent link
<p><strong>Returns</strong></p>
<p><code>Query</code>. The query object with the applied filter.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L437">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L444">[source]</a></span></p>
<h3 id="from_response_json">from_response_json<a class="headerlink" href="#from_response_json" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">from_response_json</span><span class="p">(</span><span class="n">json_dict</span><span class="p">)</span>
</code></pre></div>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L687">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L694">[source]</a></span></p>
<h3 id="get_feature">get_feature<a class="headerlink" href="#get_feature" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">get_feature</span><span class="p">(</span><span class="n">feature_name</span><span class="p">)</span>
</code></pre></div>
Expand All @@ -1577,19 +1577,19 @@ <h3 id="get_feature">get_feature<a class="headerlink" href="#get_feature" title=
<p><strong>Returns</strong></p>
<p><code>Feature</code>. Feature object.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L564">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L571">[source]</a></span></p>
<h3 id="is_cache_feature_group_only">is_cache_feature_group_only<a class="headerlink" href="#is_cache_feature_group_only" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">is_cache_feature_group_only</span><span class="p">()</span>
</code></pre></div>
<p>Query contains only cached feature groups</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L556">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L563">[source]</a></span></p>
<h3 id="is_time_travel">is_time_travel<a class="headerlink" href="#is_time_travel" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">is_time_travel</span><span class="p">()</span>
</code></pre></div>
<p>Query contains time travel</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L189">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L196">[source]</a></span></p>
<h3 id="join">join<a class="headerlink" href="#join" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sub_query</span><span class="p">,</span> <span class="n">on</span><span class="o">=</span><span class="p">[],</span> <span class="n">left_on</span><span class="o">=</span><span class="p">[],</span> <span class="n">right_on</span><span class="o">=</span><span class="p">[],</span> <span class="n">join_type</span><span class="o">=</span><span class="s2">&quot;inner&quot;</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</code></pre></div>
Expand Down Expand Up @@ -1633,7 +1633,7 @@ <h3 id="join">join<a class="headerlink" href="#join" title="Permanent link">#</a
<p><strong>Returns</strong></p>
<p><code>Query</code>: A new Query object representing the join.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L337">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L344">[source]</a></span></p>
<h3 id="pull_changes">pull_changes<a class="headerlink" href="#pull_changes" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">pull_changes</span><span class="p">(</span><span class="n">wallclock_start_time</span><span class="p">,</span> <span class="n">wallclock_end_time</span><span class="p">)</span>
</code></pre></div>
Expand All @@ -1643,7 +1643,7 @@ <h3 id="pull_changes">pull_changes<a class="headerlink" href="#pull_changes" tit
<p><code>pull_changes</code> method is deprecated. Use
`as_of(end_wallclock_time, exclude_until=start_wallclock_time) instead.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L104">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L111">[source]</a></span></p>
<h3 id="read">read<a class="headerlink" href="#read" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">online</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">dataframe_type</span><span class="o">=</span><span class="s2">&quot;default&quot;</span><span class="p">,</span> <span class="n">read_options</span><span class="o">=</span><span class="p">{})</span>
</code></pre></div>
Expand Down Expand Up @@ -1677,7 +1677,7 @@ <h3 id="read">read<a class="headerlink" href="#read" title="Permanent link">#</a
<p><strong>Returns</strong></p>
<p><code>DataFrame</code>: DataFrame depending on the chosen type.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L165">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L172">[source]</a></span></p>
<h3 id="show">show<a class="headerlink" href="#show" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">online</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</code></pre></div>
Expand All @@ -1698,7 +1698,7 @@ <h3 id="show">show<a class="headerlink" href="#show" title="Permanent link">#</a
<li><strong>online</strong> <code>Optional[bool]</code>: Show from online storage. Defaults to <code>False</code>.</li>
</ul>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L496">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L503">[source]</a></span></p>
<h3 id="to_string">to_string<a class="headerlink" href="#to_string" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">Query</span><span class="o">.</span><span class="n">to_string</span><span class="p">(</span><span class="n">online</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">arrow_flight</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</code></pre></div>
Expand All @@ -1714,27 +1714,27 @@ <h3 id="to_string">to_string<a class="headerlink" href="#to_string" title="Perma
</div>
<hr />
<h2 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h2>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L654">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L661">[source]</a></span></p>
<h3 id="featuregroups">featuregroups<a class="headerlink" href="#featuregroups" title="Permanent link">#</a></h3>
<p>List of feature groups used in the query</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L674">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L681">[source]</a></span></p>
<h3 id="features">features<a class="headerlink" href="#features" title="Permanent link">#</a></h3>
<p>List of all features in the query</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L662">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L669">[source]</a></span></p>
<h3 id="filters">filters<a class="headerlink" href="#filters" title="Permanent link">#</a></h3>
<p>All filters used in the query</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L649">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L656">[source]</a></span></p>
<h3 id="joins">joins<a class="headerlink" href="#joins" title="Permanent link">#</a></h3>
<p>List of joins in the query</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L530">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L537">[source]</a></span></p>
<h3 id="left_feature_group_end_time">left_feature_group_end_time<a class="headerlink" href="#left_feature_group_end_time" title="Permanent link">#</a></h3>
<p>End time of time travel for the left feature group.</p>
<hr />
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L525">[source]</a></span></p>
<p><span style="float:right;"><a href="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L532">[source]</a></span></p>
<h3 id="left_feature_group_start_time">left_feature_group_start_time<a class="headerlink" href="#left_feature_group_start_time" title="Permanent link">#</a></h3>
<p>Start time of time travel for the left feature group.</p>
<hr />
Expand Down
4 changes: 2 additions & 2 deletions 3.5.0-RC5/javadoc/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:04 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:54 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions 3.5.0-RC5/javadoc/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:04 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:54 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions 3.5.0-RC5/javadoc/com/logicalclocks/hsfs/DataFormat.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataFormat (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DeltaStreamerJobConf (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EntityEndpointType (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExternalDataFormat (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions 3.5.0-RC5/javadoc/com/logicalclocks/hsfs/Feature.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Feature (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:02 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FeatureGroupBase (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_392) on Fri Jan 12 23:53:03 UTC 2024 -->
<!-- Generated by javadoc (1.8.0_392) on Thu Jan 18 16:49:53 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FeatureGroupBaseForApi (hsfs-parent 3.5.0-RC5 API)</title>
<meta name="date" content="2024-01-12">
<meta name="date" content="2024-01-18">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
Expand Down
Loading

0 comments on commit 9277f6f

Please sign in to comment.