-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fixing link to docs in readme, link tutorials to binder
- Loading branch information
Kevin M. Jablonka
committed
Nov 4, 2020
1 parent
6ba0ee7
commit e0e78d7
Showing
47 changed files
with
4,569 additions
and
146 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: e18455de809a111ac62f96b851169189 | ||
| config: 63e469976f93b5bcfef41a86030e471c | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
291 changes: 291 additions & 0 deletions
291
docs/_build/html/_modules/pyepal/pal/pal_coregionalized.html
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
|
|
||
| <!DOCTYPE html> | ||
|
|
||
| <html> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>pyepal.pal.schedules — pyepal v0.1.7+1.g6ba0ee7.dirty documentation</title> | ||
|
|
||
| <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css"> | ||
|
|
||
|
|
||
| <link rel="stylesheet" | ||
| href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> | ||
| <link rel="preload" as="font" type="font/woff2" crossorigin | ||
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> | ||
| <link rel="preload" as="font" type="font/woff2" crossorigin | ||
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> | ||
|
|
||
|
|
||
|
|
||
| <link rel="stylesheet" | ||
| href="../../../_static/vendor/open-sans_all/1.44.1/index.css"> | ||
| <link rel="stylesheet" | ||
| href="../../../_static/vendor/lato_latin-ext/1.44.1/index.css"> | ||
|
|
||
|
|
||
| <link rel="stylesheet" href="../../../_static/basic.css" type="text/css" /> | ||
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> | ||
| <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" /> | ||
|
|
||
| <link rel="preload" as="script" href="../../../_static/js/index.30270b6e4c972e43c488.js"> | ||
|
|
||
| <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> | ||
| <script src="../../../_static/jquery.js"></script> | ||
| <script src="../../../_static/underscore.js"></script> | ||
| <script src="../../../_static/doctools.js"></script> | ||
| <script src="../../../_static/language_data.js"></script> | ||
| <script src="../../../_static/clipboard.min.js"></script> | ||
| <script src="../../../_static/copybutton.js"></script> | ||
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> | ||
| <link rel="index" title="Index" href="../../../genindex.html" /> | ||
| <link rel="search" title="Search" href="../../../search.html" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta name="docsearch:language" content="en" /> | ||
| </head> | ||
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> | ||
|
|
||
| <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"> | ||
| <div class="container-xl"> | ||
|
|
||
|
|
||
| <a class="navbar-brand" href="../../../index.html"> | ||
| <img src="../../../_static/pyepal_logo.png" class="logo" alt="logo"> | ||
| </a> | ||
|
|
||
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <span class="navbar-toggler-icon"></span> | ||
| </button> | ||
|
|
||
| <div id="navbar-menu" class="col-lg-9 collapse navbar-collapse"> | ||
| <ul id="navbar-main-elements" class="navbar-nav mr-auto"> | ||
|
|
||
|
|
||
| <li class="nav-item "> | ||
| <a class="nav-link" href="../../../getting_started.html">Getting Started</a> | ||
| </li> | ||
|
|
||
| <li class="nav-item "> | ||
| <a class="nav-link" href="../../../tutorials.html">Tutorials</a> | ||
| </li> | ||
|
|
||
| <li class="nav-item "> | ||
| <a class="nav-link" href="../../../background.html">Background</a> | ||
| </li> | ||
|
|
||
| <li class="nav-item "> | ||
| <a class="nav-link" href="../../../api.html">The PyePAL API reference</a> | ||
| </li> | ||
|
|
||
| <li class="nav-item "> | ||
| <a class="nav-link" href="../../../developer_notes.html">Developer notes</a> | ||
| </li> | ||
|
|
||
|
|
||
| </ul> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <ul class="navbar-nav"> | ||
|
|
||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://github.com/kjappelbaum/pyepal" target="_blank" rel="noopener"> | ||
| <span><i class="fab fa-github-square"></i></span> | ||
| </a> | ||
| </li> | ||
|
|
||
|
|
||
| </ul> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
|
|
||
| <div class="container-xl"> | ||
| <div class="row"> | ||
|
|
||
| <div class="col-12 col-md-3 bd-sidebar"> | ||
|
|
||
| <form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> | ||
| <i class="icon fas fa-search"></i> | ||
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > | ||
| </form> | ||
|
|
||
|
|
||
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> | ||
|
|
||
| <div class="bd-toc-item active"> | ||
|
|
||
|
|
||
| <ul class="nav bd-sidenav"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </ul> | ||
|
|
||
| </nav> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class="d-none d-xl-block col-xl-2 bd-toc"> | ||
|
|
||
|
|
||
| <nav id="bd-toc-nav"> | ||
| <ul class="nav section-nav flex-column"> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> | ||
|
|
||
| <div> | ||
|
|
||
| <h1>Source code for pyepal.pal.schedules</h1><div class="highlight"><pre> | ||
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> | ||
| <span class="c1"># Copyright 2020 PyePAL authors</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> | ||
| <span class="c1"># you may not use this file except in compliance with the License.</span> | ||
| <span class="c1"># You may obtain a copy of the License at</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> | ||
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> | ||
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> | ||
| <span class="c1"># See the License for the specific language governing permissions and</span> | ||
| <span class="c1"># limitations under the License.</span> | ||
|
|
||
|
|
||
| <span class="sd">"""Provides some scheduling functions</span> | ||
| <span class="sd">that can be used to implement the _should_optimize_hyperparameters function"""</span> | ||
| <span class="kn">import</span> <span class="nn">math</span> | ||
|
|
||
| <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> | ||
|
|
||
|
|
||
| <div class="viewcode-block" id="linear"><a class="viewcode-back" href="../../../api.html#pyepal.pal.schedules.linear">[docs]</a><span class="k">def</span> <span class="nf">linear</span><span class="p">(</span><span class="n">iteration</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">frequency</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> | ||
| <span class="sd">"""Optimize hyperparameters at equally spaced intervals</span> | ||
|
|
||
| <span class="sd"> Args:</span> | ||
| <span class="sd"> iteration (int): current iteration</span> | ||
| <span class="sd"> frequency (int, optional): Spacing between the True outputs. Defaults to 10.</span> | ||
|
|
||
| <span class="sd"> Returns:</span> | ||
| <span class="sd"> bool: True if iteration can be divided by frequency without remainder</span> | ||
| <span class="sd"> """</span> | ||
| <span class="k">if</span> <span class="n">iteration</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> | ||
| <span class="k">return</span> <span class="kc">True</span> | ||
| <span class="k">if</span> <span class="n">iteration</span> <span class="o">%</span> <span class="n">frequency</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> | ||
| <span class="k">return</span> <span class="kc">True</span> | ||
| <span class="k">return</span> <span class="kc">False</span></div> | ||
|
|
||
|
|
||
| <div class="viewcode-block" id="exp_decay"><a class="viewcode-back" href="../../../api.html#pyepal.pal.schedules.exp_decay">[docs]</a><span class="k">def</span> <span class="nf">exp_decay</span><span class="p">(</span><span class="n">iteration</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">base</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> | ||
| <span class="sd">"""Optimize hyperparameters at logartihmically spaced intervals</span> | ||
|
|
||
| <span class="sd"> Args:</span> | ||
| <span class="sd"> iteration (int): current iteration</span> | ||
| <span class="sd"> base (int, optional): Base of the logarithm. Defaults to 10.</span> | ||
|
|
||
| <span class="sd"> Returns:</span> | ||
| <span class="sd"> bool: True if iteration is on the log scaled grid</span> | ||
| <span class="sd"> """</span> | ||
| <span class="k">if</span> <span class="n">iteration</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> | ||
| <span class="k">return</span> <span class="kc">True</span> | ||
|
|
||
| <span class="n">result</span> <span class="o">=</span> <span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">iteration</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span> | ||
| <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">result</span> <span class="o">-</span> <span class="nb">round</span><span class="p">(</span><span class="n">result</span><span class="p">))</span> <span class="o"><</span> <span class="mf">0.00001</span><span class="p">:</span> | ||
| <span class="k">return</span> <span class="kc">True</span> | ||
| <span class="k">return</span> <span class="kc">False</span></div> | ||
| </pre></div> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| <div class='prev-next-bottom'> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </main> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| <script src="../../../_static/js/index.30270b6e4c972e43c488.js"></script> | ||
|
|
||
|
|
||
| <footer class="footer mt-5 mt-md-0"> | ||
| <div class="container"> | ||
| <p> | ||
| © Copyright 2020, Kevin Maik Jablonka, Brian Yoo, Berend Smit.<br/> | ||
| </p> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.