Skip to content

Commit

Permalink
Improve API formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaelbrundage
michaelbrundage committed Jun 22, 2021
1 parent 8507408 commit 356718e
Show file tree
Hide file tree
Showing 119 changed files with 19,771 additions and 6,655 deletions.
201 changes: 168 additions & 33 deletions api/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,34 @@

<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<!--
<link rel="alternate" type="application/rss+xml" href="/Kats/blog/rss.xml" title="Kats Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/Kats/blog/atom.xml" title="Kats Blog Atom Feed">
-->
<link rel="preconnect" href="https://www.google-analytics.com">
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-149862507-1","auto"),ga("send","pageview")</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
<!--
<title data-react-helmet="true">Kats | Kats</title>
<meta data-react-helmet="true" property="og:title" content="Kats | Kats">
<meta data-react-helmet="true" name="description" content="One stop shop for time series analysis in Python">
<meta data-react-helmet="true" property="og:description" content="One stop shop for time series analysis in Python">
<meta data-react-helmet="true" property="og:url" content="https://facebookresearch.github.io/Kats/">
-->
<link data-react-helmet="true" rel="shortcut icon" href="/Kats/img/KatsHeroLogo.png">
<!--
<link data-react-helmet="true" rel="canonical" href="https://facebookresearch.github.io/Kats/">
<link data-react-helmet="true" rel="alternate" href="https://facebookresearch.github.io/Kats/" hreflang="en">
<link data-react-helmet="true" rel="alternate" href="https://facebookresearch.github.io/Kats/" hreflang="x-default">
-->
<link rel="stylesheet" href="/Kats/assets/css/styles.99fd060a.css">
<!--
<link rel="preload" href="/Kats/assets/js/runtime~main.9e005abd.js" as="script">
<link rel="preload" href="/Kats/assets/js/main.6382ca5e.js" as="script">
-->
</head>


<!DOCTYPE html>

<html>
Expand All @@ -8,22 +38,113 @@
<title>Overview: module code &#8212; Kats 0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<!--
<link rel="alternate" type="application/rss+xml" href="/Kats/blog/rss.xml" title="Kats Blog RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/Kats/blog/atom.xml" title="Kats Blog Atom Feed">
-->
<link rel="preconnect" href="https://www.google-analytics.com">
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-149862507-1","auto"),ga("send","pageview")</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
<!--
<title data-react-helmet="true">Kats | Kats</title>
<meta data-react-helmet="true" property="og:title" content="Kats | Kats">
<meta data-react-helmet="true" name="description" content="One stop shop for time series analysis in Python">
<meta data-react-helmet="true" property="og:description" content="One stop shop for time series analysis in Python">
<meta data-react-helmet="true" property="og:url" content="https://facebookresearch.github.io/Kats/">
-->
<link data-react-helmet="true" rel="shortcut icon" href="/Kats/img/KatsHeroLogo.png">
<!--
<link data-react-helmet="true" rel="canonical" href="https://facebookresearch.github.io/Kats/">
<link data-react-helmet="true" rel="alternate" href="https://facebookresearch.github.io/Kats/" hreflang="en">
<link data-react-helmet="true" rel="alternate" href="https://facebookresearch.github.io/Kats/" hreflang="x-default">
-->
<link rel="stylesheet" href="/Kats/assets/css/styles.99fd060a.css">
<!--
<link rel="preload" href="/Kats/assets/js/runtime~main.9e005abd.js" as="script">
<link rel="preload" href="/Kats/assets/js/main.6382ca5e.js" as="script">
-->
</head>

</head><body>


<div class="document">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script>
<!--<div id="__docusaurus">-->
<div id="docusaurus-base-url-issue-banner-container"></div>
<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div>
<nav class="navbar navbar--fixed-top">
<div class="navbar__inner">
<div class="navbar__items">
<button aria-label="Navigation bar toggle" class="navbar__toggle" type="button" tabindex="0">
<svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false">
<title>Menu</title>
<path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path>
</svg>
</button>
<a class="navbar__brand" href="/Kats/">
<img src="/Kats/img/KatsHeroLogo.png" alt="Project Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"/>
<img src="/Kats/img/KatsHeroLogo.png" alt="Project Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"/>
<strong class="navbar__title">Kats</strong>
</a>
<a href="https://facebookresearch.github.io/Kats/api/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">API</a>
<a href="https://github.com/facebookresearch/Kats/tree/master/tutorials" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Tutorials</a>
</div>
<!--
<div class="navbar__items navbar__items--right">
<a href="https://github.com/facebookresearch/kats" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Kats@GitHub</a>
<div class="react-toggle displayOnlyInLargeViewport_GrZ2" role="button" tabindex="-1">
<div class="react-toggle-track">
<div class="react-toggle-track-check">
<span class="toggle_71bT">🌜</span>
</div>
<div class="react-toggle-track-x">
<span class="toggle_71bT">🌞</span>
</div>
</div>
<div class="react-toggle-thumb"></div>
<input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"/>
</div>
</div>
-->
</div>
<div role="presentation" class="navbar-sidebar__backdrop"></div>
<div class="navbar-sidebar">
<div class="navbar-sidebar__brand">
<a class="navbar__brand" href="/Kats/">
<img src="/Kats/img/KatsHeroLogo.png" alt="Project Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"/>
<img src="/Kats/img/KatsHeroLogo.png" alt="Project Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"/>
<strong class="navbar__title">Kats</strong>
</a>
</div>
<div class="navbar-sidebar__items">
<div class="menu">
<ul class="menu__list">
<li class="menu__list-item">
<a href="https://facebookresearch.github.io/Kats/api/" target="_blank" rel="noopener noreferrer" class="menu__link">API</a>
</li>
<li class="menu__list-item">
<a href="https://github.com/facebookresearch/Kats/tree/master/tutorials" target="_blank" rel="noopener noreferrer" class="menu__link">Tutorials</a>
</li>
<li class="menu__list-item">
<a href="https://github.com/facebookresearch/kats" target="_blank" rel="noopener noreferrer" class="menu__link">Kats@GitHub</a>
</li>
</ul>
</div>
</div>
</div>
</nav>
<div class="main-wrapper">

<div class="documentwrapper">
<div class="bodywrapper">

Expand All @@ -45,35 +166,7 @@ <h1>All modules for which code is available</h1>
<li><a href="kats/detectors/robust_stat_detection.html">kats.detectors.robust_stat_detection</a></li>
<li><a href="kats/detectors/seasonality.html">kats.detectors.seasonality</a></li>
<li><a href="kats/detectors/stat_sig_detector.html">kats.detectors.stat_sig_detector</a></li>
<li><a href="kats/detectors/trend_mk.html">kats.detectors.trend_mk</a></li>
<li><a href="kats/graphics/plots.html">kats.graphics.plots</a></li>
<li><a href="kats/models/arima.html">kats.models.arima</a></li>
<li><a href="kats/models/bayesian_var.html">kats.models.bayesian_var</a></li>
<li><a href="kats/models/ensemble/ensemble.html">kats.models.ensemble.ensemble</a></li>
<li><a href="kats/models/ensemble/kats_ensemble.html">kats.models.ensemble.kats_ensemble</a></li>
<li><a href="kats/models/ensemble/median_ensemble.html">kats.models.ensemble.median_ensemble</a></li>
<li><a href="kats/models/ensemble/weighted_avg_ensemble.html">kats.models.ensemble.weighted_avg_ensemble</a></li>
<li><a href="kats/models/harmonic_regression.html">kats.models.harmonic_regression</a></li>
<li><a href="kats/models/holtwinters.html">kats.models.holtwinters</a></li>
<li><a href="kats/models/linear_model.html">kats.models.linear_model</a></li>
<li><a href="kats/models/lstm.html">kats.models.lstm</a></li>
<li><a href="kats/models/metalearner/get_metadata.html">kats.models.metalearner.get_metadata</a></li>
<li><a href="kats/models/metalearner/metalearner_hpt.html">kats.models.metalearner.metalearner_hpt</a></li>
<li><a href="kats/models/metalearner/metalearner_modelselect.html">kats.models.metalearner.metalearner_modelselect</a></li>
<li><a href="kats/models/metalearner/metalearner_predictability.html">kats.models.metalearner.metalearner_predictability</a></li>
<li><a href="kats/models/model.html">kats.models.model</a></li>
<li><a href="kats/models/nowcasting/feature_extraction.html">kats.models.nowcasting.feature_extraction</a></li>
<li><a href="kats/models/nowcasting/model_io.html">kats.models.nowcasting.model_io</a></li>
<li><a href="kats/models/nowcasting/nowcasting.html">kats.models.nowcasting.nowcasting</a></li>
<li><a href="kats/models/prophet.html">kats.models.prophet</a></li>
<li><a href="kats/models/quadratic_model.html">kats.models.quadratic_model</a></li>
<li><a href="kats/models/reconciliation/base_models.html">kats.models.reconciliation.base_models</a></li>
<li><a href="kats/models/reconciliation/thm.html">kats.models.reconciliation.thm</a></li>
<li><a href="kats/models/sarima.html">kats.models.sarima</a></li>
<li><a href="kats/models/stlf.html">kats.models.stlf</a></li>
<li><a href="kats/models/theta.html">kats.models.theta</a></li>
<li><a href="kats/models/var.html">kats.models.var</a></li>
<li><a href="kats/tsfeatures/tsfeatures.html">kats.tsfeatures.tsfeatures</a></li>
<li><a href="kats/utils/backtesters.html">kats.utils.backtesters</a></li>
<li><a href="kats/utils/cupik.html">kats.utils.cupik</a></li>
<li><a href="kats/utils/decomposition.html">kats.utils.decomposition</a></li>
Expand All @@ -87,6 +180,48 @@ <h1>All modules for which code is available</h1>

</div>
</div>
</div>
<footer class="footer">
<div class="container">
<div class="row footer__links">
<div class="col footer__col">
<div class="footer__title">Links</div>
<ul class="footer__items">
<li class="footer__item">
<a href="https://github.com/facebookresearch/Kats" target="_blank" rel="noopener noreferrer" class="footer__link-item">Kats@GitHub</a>
</li>
</ul>
</div>
<div class="col footer__col">
<div class="footer__title">Legal</div>
<ul class="footer__items">
<li class="footer__item">
<a href="https://opensource.facebook.com/legal/privacy/" target="_blank" rel="noreferrer noopener" class="footer__link-item">Privacy</a>
</li>
<li class="footer__item">
<a href="https://opensource.facebook.com/legal/terms/" target="_blank" rel="noreferrer noopener" class="footer__link-item">Terms</a>
</li>
<li class="footer__item">
<a href="https://opensource.facebook.com/legal/cookie-policy" target="_blank" rel="noreferrer noopener" class="footer__link-item">Cookies</a>
</li>
</ul>
</div>
</div>
<div class="footer__bottom text--center">
<div class="margin-bottom--sm">
<img src="https://docusaurus.io/img/oss_logo.png" alt="Facebook Open Source Logo" class="themedImage_1VuW themedImage--light_3UqQ footer__logo"/>
<img src="https://docusaurus.io/img/oss_logo.png" alt="Facebook Open Source Logo" class="themedImage_1VuW themedImage--dark_hz6m footer__logo"/>
</div>
<div class="footer__copyright">Copyright © 2021 Facebook, Inc.</div>
</div>
</div>
</footer>
<!--
</div>
<script src="/Kats/assets/js/runtime~main.9e005abd.js"></script>
<script src="/Kats/assets/js/main.6382ca5e.js"></script>
-->

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Kats</a></h1>
Expand Down

0 comments on commit 356718e

Please sign in to comment.