Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 4, 2024
1 parent bed69db commit 8c6c2ee
Show file tree
Hide file tree
Showing 504 changed files with 101,547 additions and 7,389 deletions.
79 changes: 26 additions & 53 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../_static/styles/theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />


<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link href="../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />

<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
Expand All @@ -38,9 +38,9 @@
<link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509" />
<script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=bd9e20870c6007c4c509"></script>

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
Expand Down Expand Up @@ -77,7 +77,7 @@



<a class="skip-link" href="#main-content">Skip to main content</a>
<a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>

Expand Down Expand Up @@ -120,13 +120,21 @@
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>

<header>

<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-header navbar navbar-expand-lg bd-navbar">
</div>

</header>

<div class="bd-container">
<div class="bd-container__inner bd-page-width">





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -315,7 +323,7 @@ <h1></h1>


<div id="searchbox"></div>
<article class="bd-article" role="main">
<article class="bd-article">

<h1>All modules for which code is available</h1>
<ul><li><a href="recommenders/datasets/amazon_reviews.html">recommenders.datasets.amazon_reviews</a></li>
Expand All @@ -331,59 +339,23 @@ <h1>All modules for which code is available</h1>
<li><a href="recommenders/datasets/split_utils.html">recommenders.datasets.split_utils</a></li>
<li><a href="recommenders/datasets/wikidata.html">recommenders.datasets.wikidata</a></li>
<li><a href="recommenders/evaluation/python_evaluation.html">recommenders.evaluation.python_evaluation</a></li>
<li><a href="recommenders/evaluation/spark_evaluation.html">recommenders.evaluation.spark_evaluation</a></li>
<li><a href="recommenders/models/cornac/cornac_utils.html">recommenders.models.cornac.cornac_utils</a></li>
<li><a href="recommenders/models/deeprec/DataModel/ImplicitCF.html">recommenders.models.deeprec.DataModel.ImplicitCF</a></li>
<li><a href="recommenders/models/deeprec/deeprec_utils.html">recommenders.models.deeprec.deeprec_utils</a></li>
<li><a href="recommenders/models/deeprec/io/dkn_item2item_iterator.html">recommenders.models.deeprec.io.dkn_item2item_iterator</a></li>
<li><a href="recommenders/models/deeprec/io/dkn_iterator.html">recommenders.models.deeprec.io.dkn_iterator</a></li>
<li><a href="recommenders/models/deeprec/io/iterator.html">recommenders.models.deeprec.io.iterator</a></li>
<li><a href="recommenders/models/deeprec/io/nextitnet_iterator.html">recommenders.models.deeprec.io.nextitnet_iterator</a></li>
<li><a href="recommenders/models/deeprec/io/sequential_iterator.html">recommenders.models.deeprec.io.sequential_iterator</a></li>
<li><a href="recommenders/models/deeprec/models/base_model.html">recommenders.models.deeprec.models.base_model</a></li>
<li><a href="recommenders/models/deeprec/models/dkn.html">recommenders.models.deeprec.models.dkn</a></li>
<li><a href="recommenders/models/deeprec/models/dkn_item2item.html">recommenders.models.deeprec.models.dkn_item2item</a></li>
<li><a href="recommenders/models/deeprec/models/graphrec/lightgcn.html">recommenders.models.deeprec.models.graphrec.lightgcn</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/asvd.html">recommenders.models.deeprec.models.sequential.asvd</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/caser.html">recommenders.models.deeprec.models.sequential.caser</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/gru.html">recommenders.models.deeprec.models.sequential.gru</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/nextitnet.html">recommenders.models.deeprec.models.sequential.nextitnet</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/rnn_cell_implement.html">recommenders.models.deeprec.models.sequential.rnn_cell_implement</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/sequential_base_model.html">recommenders.models.deeprec.models.sequential.sequential_base_model</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/sli_rec.html">recommenders.models.deeprec.models.sequential.sli_rec</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/sum.html">recommenders.models.deeprec.models.sequential.sum</a></li>
<li><a href="recommenders/models/deeprec/models/sequential/sum_cells.html">recommenders.models.deeprec.models.sequential.sum_cells</a></li>
<li><a href="recommenders/models/deeprec/models/xDeepFM.html">recommenders.models.deeprec.models.xDeepFM</a></li>
<li><a href="recommenders/models/fastai/fastai_utils.html">recommenders.models.fastai.fastai_utils</a></li>
<li><a href="recommenders/models/geoimc/geoimc_data.html">recommenders.models.geoimc.geoimc_data</a></li>
<li><a href="recommenders/models/geoimc/geoimc_predict.html">recommenders.models.geoimc.geoimc_predict</a></li>
<li><a href="recommenders/models/geoimc/geoimc_utils.html">recommenders.models.geoimc.geoimc_utils</a></li>
<li><a href="recommenders/models/lightfm/lightfm_utils.html">recommenders.models.lightfm.lightfm_utils</a></li>
<li><a href="recommenders/models/lightgbm/lightgbm_utils.html">recommenders.models.lightgbm.lightgbm_utils</a></li>
<li><a href="recommenders/models/ncf/dataset.html">recommenders.models.ncf.dataset</a></li>
<li><a href="recommenders/models/ncf/ncf_singlenode.html">recommenders.models.ncf.ncf_singlenode</a></li>
<li><a href="recommenders/models/newsrec/io/mind_all_iterator.html">recommenders.models.newsrec.io.mind_all_iterator</a></li>
<li><a href="recommenders/models/newsrec/io/mind_iterator.html">recommenders.models.newsrec.io.mind_iterator</a></li>
<li><a href="recommenders/models/newsrec/models/base_model.html">recommenders.models.newsrec.models.base_model</a></li>
<li><a href="recommenders/models/newsrec/models/layers.html">recommenders.models.newsrec.models.layers</a></li>
<li><a href="recommenders/models/newsrec/models/lstur.html">recommenders.models.newsrec.models.lstur</a></li>
<li><a href="recommenders/models/newsrec/models/naml.html">recommenders.models.newsrec.models.naml</a></li>
<li><a href="recommenders/models/newsrec/models/npa.html">recommenders.models.newsrec.models.npa</a></li>
<li><a href="recommenders/models/newsrec/models/nrms.html">recommenders.models.newsrec.models.nrms</a></li>
<li><a href="recommenders/models/newsrec/newsrec_utils.html">recommenders.models.newsrec.newsrec_utils</a></li>
<li><a href="recommenders/models/rbm/rbm.html">recommenders.models.rbm.rbm</a></li>
<li><a href="recommenders/models/rlrmc/RLRMCdataset.html">recommenders.models.rlrmc.RLRMCdataset</a></li>
<li><a href="recommenders/models/sar/sar_singlenode.html">recommenders.models.sar.sar_singlenode</a></li>
<li><a href="recommenders/models/sasrec/model.html">recommenders.models.sasrec.model</a></li>
<li><a href="recommenders/models/sasrec/sampler.html">recommenders.models.sasrec.sampler</a></li>
<li><a href="recommenders/models/sasrec/ssept.html">recommenders.models.sasrec.ssept</a></li>
<li><a href="recommenders/models/sasrec/util.html">recommenders.models.sasrec.util</a></li>
<li><a href="recommenders/models/surprise/surprise_utils.html">recommenders.models.surprise.surprise_utils</a></li>
<li><a href="recommenders/models/tfidf/tfidf_utils.html">recommenders.models.tfidf.tfidf_utils</a></li>
<li><a href="recommenders/models/vae/multinomial_vae.html">recommenders.models.vae.multinomial_vae</a></li>
<li><a href="recommenders/models/vae/standard_vae.html">recommenders.models.vae.standard_vae</a></li>
<li><a href="recommenders/models/vowpal_wabbit/vw.html">recommenders.models.vowpal_wabbit.vw</a></li>
<li><a href="recommenders/models/wide_deep/wide_deep_utils.html">recommenders.models.wide_deep.wide_deep_utils</a></li>
<li><a href="recommenders/tuning/parameter_sweep.html">recommenders.tuning.parameter_sweep</a></li>
<li><a href="recommenders/utils/general_utils.html">recommenders.utils.general_utils</a></li>
<li><a href="recommenders/utils/gpu_utils.html">recommenders.utils.gpu_utils</a></li>
Expand All @@ -393,7 +365,6 @@ <h1>All modules for which code is available</h1>
<li><a href="recommenders/utils/plot.html">recommenders.utils.plot</a></li>
<li><a href="recommenders/utils/python_utils.html">recommenders.utils.python_utils</a></li>
<li><a href="recommenders/utils/spark_utils.html">recommenders.utils.spark_utils</a></li>
<li><a href="recommenders/utils/tf_utils.html">recommenders.utils.tf_utils</a></li>
<li><a href="recommenders/utils/timer.html">recommenders.utils.timer</a></li>
</ul>

Expand All @@ -414,6 +385,8 @@ <h1>All modules for which code is available</h1>



<div class="bd-sidebar-secondary bd-toc"></div>


</div>
<footer class="bd-footer-content">
Expand Down Expand Up @@ -457,8 +430,8 @@ <h1>All modules for which code is available</h1>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>
<script src="../_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509"></script>

<footer class="bd-footer">
</footer>
Expand Down
42 changes: 26 additions & 16 deletions _modules/recommenders/datasets/amazon_reviews.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../../../_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../../../_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="../../../_static/styles/theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="../../../_static/styles/bootstrap.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />


<link href="../../../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link href="../../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />

<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
Expand All @@ -38,9 +38,9 @@
<link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
<script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509" />
<script src="../../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=bd9e20870c6007c4c509"></script>

<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
Expand Down Expand Up @@ -77,7 +77,7 @@



<a class="skip-link" href="#main-content">Skip to main content</a>
<a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>

Expand Down Expand Up @@ -120,13 +120,21 @@
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>

<header>

<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-header navbar navbar-expand-lg bd-navbar">
</div>

</header>

<div class="bd-container">
<div class="bd-container__inner bd-page-width">





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -315,7 +323,7 @@ <h1></h1>


<div id="searchbox"></div>
<article class="bd-article" role="main">
<article class="bd-article">

<h1>Source code for recommenders.datasets.amazon_reviews</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright (c) Recommenders contributors.</span>
Expand Down Expand Up @@ -887,6 +895,8 @@ <h1>Source code for recommenders.datasets.amazon_reviews</h1><div class="highlig



<div class="bd-sidebar-secondary bd-toc"></div>


</div>
<footer class="bd-footer-content">
Expand Down Expand Up @@ -930,8 +940,8 @@ <h1>Source code for recommenders.datasets.amazon_reviews</h1><div class="highlig
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../../../_static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
<script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>
<script src="../../../_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509"></script>
<script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509"></script>

<footer class="bd-footer">
</footer>
Expand Down
Loading

0 comments on commit 8c6c2ee

Please sign in to comment.