diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo index 446a381b11332e6fff5233edeeef1bd62be666b7..d7dc8973cdc3a39b18dc27cfcc3811e9521b70f2 100644 --- a/docs/build/.buildinfo +++ b/docs/build/.buildinfo @@ -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: 3263cdca96b2e12deb87c2b5261200a2 +config: 4c918d26bc1f4b19df960586760ccaa9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle index 9be7730d7da2019ded93d1ee30a0a84d81371fb8..06d728e01732970df5badacc409b809acab752a2 100644 Binary files a/docs/build/.doctrees/environment.pickle and b/docs/build/.doctrees/environment.pickle differ diff --git a/docs/build/api.html b/docs/build/api.html index 895c25031a79d7fd012c8a5a323d12241900bf65..192ed747d05d45e6cbcc213051c538eeacf35170 100644 --- a/docs/build/api.html +++ b/docs/build/api.html @@ -1,51 +1,175 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>API Documentation — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>API Documentation — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Multiview dataset management" href="api_files/dataset.html" /> <link rel="prev" title="Taking control : Use your own algorithms" href="tutorials/example5.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="api_files/dataset.html" title="Multiview dataset management" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="tutorials/example5.html" title="Taking control : Use your own algorithms" - accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> SuMMIT + + + + + <img src="_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">SuMMIT Tutorials</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="api_files/dataset.html">Multiview dataset management</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html" class="icon icon-home"></a> »</li> + + <li>API Documentation</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="api-documentation"> <h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1> @@ -57,59 +181,51 @@ </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h4>Previous topic</h4> - <p class="topless"><a href="tutorials/example5.html" - title="previous chapter">Taking control : Use your own algorithms</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="api_files/dataset.html" - title="next chapter">Multiview dataset management</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="_sources/api.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="api_files/dataset.html" class="btn btn-neutral float-right" title="Multiview dataset management" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="tutorials/example5.html" class="btn btn-neutral float-left" title="Taking control : Use your own algorithms" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="api_files/dataset.html" title="Multiview dataset management" - >next</a> |</li> - <li class="right" > - <a href="tutorials/example5.html" title="Taking control : Use your own algorithms" - >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/genindex.html b/docs/build/genindex.html index d02864511b8e3718ead4a80153c6a2f34ead6292..2909ae4c735b4a5cee7f0753129b9aac8fbe31ec 100644 --- a/docs/build/genindex.html +++ b/docs/build/genindex.html @@ -1,44 +1,169 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Index — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Index — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" 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/plotly_js.js"></script> - <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/plotly_js.js"></script> + <script type="text/javascript" src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="#" /> <link rel="search" title="Search" href="search.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="#" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> SuMMIT + + + + + <img src="_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">SuMMIT Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html" class="icon icon-home"></a> »</li> + + <li>Index</li> + + + <li class="wy-breadcrumbs-aside"> + + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <h1 id="index">Index</h1> @@ -620,40 +745,47 @@ + </div> + </div> + <footer> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script>$('#searchbox').show(0);</script> - </div> - </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="#" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/index.html b/docs/build/index.html index 6b21f468863c6fd73fedd48dd3970b88fb5664bb..9efb4d3aa6e64c810453c76bc4a66ba7e3f2bddc 100644 --- a/docs/build/index.html +++ b/docs/build/index.html @@ -1,47 +1,171 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Welcome to Supervised MultiModal Integration Tool’s documentation — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Welcome to Supervised MultiModal Integration Tool’s documentation — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="SuMMIT Tutorials" href="tutorials/index.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="tutorials/index.html" title="SuMMIT Tutorials" - accesskey="N">next</a> |</li> - <li class="nav-item nav-item-0"><a href="#">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="#" class="icon icon-home"> SuMMIT + + + + + <img src="_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">SuMMIT Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="#">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="#" class="icon icon-home"></a> »</li> + + <li>Welcome to Supervised MultiModal Integration Tool’s documentation</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="welcome-to-supervised-multimodal-integration-tool-s-documentation"> <h1>Welcome to Supervised MultiModal Integration Tool’s documentation<a class="headerlink" href="#welcome-to-supervised-multimodal-integration-tool-s-documentation" title="Permalink to this headline">¶</a></h1> @@ -233,78 +357,50 @@ Results will, by default, be stored in the results directory of the installation </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h3><a href="#">Table of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Welcome to Supervised MultiModal Integration Tool’s documentation</a><ul> -</ul> -</li> -<li><a class="reference internal" href="#read-me">Read me</a></li> -<li><a class="reference internal" href="#supervised-multimodal-integration-tool-s-readme">Supervised MultiModal Integration Tool’s Readme</a><ul> -<li><a class="reference internal" href="#getting-started">Getting Started</a><ul> -<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li> -<li><a class="reference internal" href="#installing">Installing</a></li> -<li><a class="reference internal" href="#running-the-tests">Running the tests</a></li> -<li><a class="reference internal" href="#building-the-documentation">Building the documentation</a></li> -<li><a class="reference internal" href="#running-on-simulated-data">Running on simulated data</a></li> -<li><a class="reference internal" href="#dataset-compatibility">Dataset compatibility</a><ul> -<li><a class="reference internal" href="#running-on-your-dataset">Running on your dataset</a></li> -</ul> -</li> -</ul> -</li> -<li><a class="reference internal" href="#authors">Authors</a></li> -</ul> -</li> -<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> -</ul> - - <h4>Next topic</h4> - <p class="topless"><a href="tutorials/index.html" - title="next chapter">SuMMIT Tutorials</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="_sources/index.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="tutorials/index.html" class="btn btn-neutral float-right" title="SuMMIT Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="tutorials/index.html" title="SuMMIT Tutorials" - >next</a> |</li> - <li class="nav-item nav-item-0"><a href="#">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/readme_link.html b/docs/build/readme_link.html index b5e56c248789f049bd5a302127879d4d0d468e31..3faded82cbcb6b226f4b828f2792f9bbb92d648f 100644 --- a/docs/build/readme_link.html +++ b/docs/build/readme_link.html @@ -1,43 +1,170 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Supervised MultiModal Integration Tool’s Readme — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Supervised MultiModal Integration Tool’s Readme — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> SuMMIT + + + + + <img src="_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">SuMMIT Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html" class="icon icon-home"></a> »</li> + + <li>Supervised MultiModal Integration Tool’s Readme</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/readme_link.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <p><img alt="Pipeline status" src="https://gitlab.lis-lab.fr/baptiste.bauvin/summit/badges/master/pipeline.svg" /> <a class="reference external" href="http://www.gnu.org/licenses/gpl-3.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-GPL%20v3-blue.svg" /></a> <a class="reference external" href="http://baptiste.bauvin.pages.lis-lab.fr/summit/coverage/index.html"><img alt="Coverage" src="https://gitlab.lis-lab.fr/baptiste.bauvin/summit/badges/master/coverage.svg" /></a></p> <div class="section" id="supervised-multimodal-integration-tool-s-readme"> @@ -160,67 +287,47 @@ Results will, by default, be stored in the results directory of the installation </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h3><a href="index.html">Table of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Supervised MultiModal Integration Tool’s Readme</a><ul> -<li><a class="reference internal" href="#getting-started">Getting Started</a><ul> -<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li> -<li><a class="reference internal" href="#installing">Installing</a></li> -<li><a class="reference internal" href="#running-the-tests">Running the tests</a></li> -<li><a class="reference internal" href="#building-the-documentation">Building the documentation</a></li> -<li><a class="reference internal" href="#running-on-simulated-data">Running on simulated data</a></li> -<li><a class="reference internal" href="#dataset-compatibility">Dataset compatibility</a><ul> -<li><a class="reference internal" href="#running-on-your-dataset">Running on your dataset</a></li> -</ul> -</li> -</ul> -</li> -<li><a class="reference internal" href="#authors">Authors</a></li> -</ul> -</li> -</ul> + <footer> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="_sources/readme_link.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script>$('#searchbox').show(0);</script> +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/search.html b/docs/build/search.html index 6d23455b020bce63a0e85f257de0935d7dd9f677..3c073c59d4c9853a1aa219a3f6a454d7d0a835c5 100644 --- a/docs/build/search.html +++ b/docs/build/search.html @@ -1,95 +1,231 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Search — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Search — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" 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/plotly_js.js"></script> - <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/plotly_js.js"></script> + <script type="text/javascript" src="_static/js/theme.js"></script> + - <script src="_static/searchtools.js"></script> + <script type="text/javascript" src="_static/searchtools.js"></script> + <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="#" /> - <script src="searchindex.js" defer></script> + <link rel="search" title="Search" href="#" /> +</head> + +<body class="wy-body-for-nav"> + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="index.html" class="icon icon-home"> SuMMIT + + + + + <img src="_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> + - <h1 id="search-documentation">Search</h1> + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="#" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">SuMMIT Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html" class="icon icon-home"></a> »</li> + + <li>Search</li> + + + <li class="wy-breadcrumbs-aside"> + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <noscript> <div id="fallback" class="admonition warning"> - <script>$('#fallback').hide();</script> - <p> - Please activate JavaScript to enable the search - functionality. - </p> + <p class="last"> + Please activate JavaScript to enable the search functionality. + </p> </div> - <p> - Searching for multiple words only shows matches that contain - all words. - </p> - <form action="" method="get"> - <input type="text" name="q" aria-labelledby="search-documentation" value="" /> - <input type="submit" value="search" /> - <span id="search-progress" style="padding-left: 10px"></span> - </form> + </noscript> + <div id="search-results"> </div> + </div> + </div> + <footer> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - </div> - </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="nav-item nav-item-0"><a href="index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + <script type="text/javascript"> + jQuery(function() { Search.loadIndex("searchindex.js"); }); + </script> + + <script type="text/javascript" id="searchindexloader"></script> + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/tutorials/example1.html b/docs/build/tutorials/example1.html index 52d668c61958894647edf11c975fc857e55ae826..5e3fa186c6b0d0f295286b6c8596c2faf3624e80 100644 --- a/docs/build/tutorials/example1.html +++ b/docs/build/tutorials/example1.html @@ -1,52 +1,197 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Example 1 : First big step with SuMMIT — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Example 1 : First big step with SuMMIT — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Example 2 : Understanding the hyper-parameter optimization" href="example2.html" /> - <link rel="prev" title="Example 0 : Getting started with SuMMIT on digits" href="example0.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example2.html" title="Example 2 : Understanding the hyper-parameter optimization" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="example0.html" title="Example 0 : Getting started with SuMMIT on digits" - accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">SuMMIT Tutorials</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> + <link rel="prev" title="Example 0 : Getting started with SuMMIT on MNist" href="example0.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> SuMMIT + + + + + <img src="../_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">SuMMIT Tutorials</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="installation.html">Install SuMMIT</a></li> +<li class="toctree-l2"><a class="reference internal" href="example0.html">Example 0 : Getting started with SuMMIT on MNist</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Example 1 : First big step with SuMMIT</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#introduction-to-this-tutorial">Introduction to this tutorial</a></li> +<li class="toctree-l3"><a class="reference internal" href="#a-generated-dataset-to-rule-them-all">A generated dataset to rule them all</a></li> +<li class="toctree-l3"><a class="reference internal" href="#getting-started">Getting started</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#accuracy-score-html-accuracy-score-png-and-accuracy-score-csv"><code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.html</span></code>, <code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.csv</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#error-analysis-2d-png-and-error-analysis-2d-html"><code class="docutils literal notranslate"><span class="pre">*-error_analysis_2D.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-error_analysis_2D.html</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#error-analysis-bar-png-and-error-analysis-bar-html"><code class="docutils literal notranslate"><span class="pre">*-error_analysis_bar.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-error_analysis_bar.html</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#config-file-yml"><code class="docutils literal notranslate"><span class="pre">config_file.yml</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#random-state-pickle"><code class="docutils literal notranslate"><span class="pre">random_state.pickle</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#log-log"><code class="docutils literal notranslate"><span class="pre">1560_12_25-15_42-*-LOG.log</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="#classifier-dependant-files">Classifier-dependant files</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="example2.html">Example 2 : Understanding the hyper-parameter optimization</a></li> +<li class="toctree-l2"><a class="reference internal" href="example3.html">Example 3 : Understanding the statistical iterations</a></li> +<li class="toctree-l2"><a class="reference internal" href="example4.html">Taking control : Use your own dataset</a></li> +<li class="toctree-l2"><a class="reference internal" href="example5.html">Taking control : Use your own algorithms</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html" class="icon icon-home"></a> »</li> + + <li><a href="index.html">SuMMIT Tutorials</a> »</li> + + <li>Example 1 : First big step with SuMMIT</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/tutorials/example1.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="example-1-first-big-step-with-platf"> <h1>Example 1 : First big step with SuMMIT<a class="headerlink" href="#example-1-first-big-step-with-platf" title="Permalink to this headline">¶</a></h1> @@ -582,79 +727,51 @@ Feature importances : </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h3><a href="../index.html">Table of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Example 1 : First big step with SuMMIT</a><ul> -<li><a class="reference internal" href="#introduction-to-this-tutorial">Introduction to this tutorial</a></li> -<li><a class="reference internal" href="#a-generated-dataset-to-rule-them-all">A generated dataset to rule them all</a></li> -<li><a class="reference internal" href="#getting-started">Getting started</a><ul> -<li><a class="reference internal" href="#accuracy-score-html-accuracy-score-png-and-accuracy-score-csv"><code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.html</span></code>, <code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-accuracy_score*.csv</span></code></a></li> -<li><a class="reference internal" href="#error-analysis-2d-png-and-error-analysis-2d-html"><code class="docutils literal notranslate"><span class="pre">*-error_analysis_2D.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-error_analysis_2D.html</span></code></a></li> -<li><a class="reference internal" href="#error-analysis-bar-png-and-error-analysis-bar-html"><code class="docutils literal notranslate"><span class="pre">*-error_analysis_bar.png</span></code> and <code class="docutils literal notranslate"><span class="pre">*-error_analysis_bar.html</span></code></a></li> -<li><a class="reference internal" href="#config-file-yml"><code class="docutils literal notranslate"><span class="pre">config_file.yml</span></code></a></li> -<li><a class="reference internal" href="#random-state-pickle"><code class="docutils literal notranslate"><span class="pre">random_state.pickle</span></code></a></li> -<li><a class="reference internal" href="#log-log"><code class="docutils literal notranslate"><span class="pre">1560_12_25-15_42-*-LOG.log</span></code></a></li> -<li><a class="reference internal" href="#classifier-dependant-files">Classifier-dependant files</a></li> -</ul> -</li> -</ul> -</li> -</ul> - - <h4>Previous topic</h4> - <p class="topless"><a href="example0.html" - title="previous chapter">Example 0 : Getting started with SuMMIT on digits</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="example2.html" - title="next chapter">Example 2 : Understanding the hyper-parameter optimization</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="../_sources/tutorials/example1.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="../search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="example2.html" class="btn btn-neutral float-right" title="Example 2 : Understanding the hyper-parameter optimization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="example0.html" class="btn btn-neutral float-left" title="Example 0 : Getting started with SuMMIT on MNist" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example2.html" title="Example 2 : Understanding the hyper-parameter optimization" - >next</a> |</li> - <li class="right" > - <a href="example0.html" title="Example 0 : Getting started with SuMMIT on digits" - >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" >SuMMIT Tutorials</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/tutorials/example2.html b/docs/build/tutorials/example2.html index 1c078ffa2ff3e2fad4c02d27ac59b535c255a6ad..c800db02333d15495010206051e2afadd583ea4c 100644 --- a/docs/build/tutorials/example2.html +++ b/docs/build/tutorials/example2.html @@ -1,52 +1,193 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Example 2 : Understanding the hyper-parameter optimization — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Example 2 : Understanding the hyper-parameter optimization — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" 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/plotly_js.js"></script> - <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/plotly_js.js"></script> + <script type="text/javascript" src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Example 3 : Understanding the statistical iterations" href="example3.html" /> <link rel="prev" title="Example 1 : First big step with SuMMIT" href="example1.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example3.html" title="Example 3 : Understanding the statistical iterations" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="example1.html" title="Example 1 : First big step with SuMMIT" - accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">SuMMIT Tutorials</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> SuMMIT + + + + + <img src="../_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">SuMMIT Tutorials</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="installation.html">Install SuMMIT</a></li> +<li class="toctree-l2"><a class="reference internal" href="example0.html">Example 0 : Getting started with SuMMIT on MNist</a></li> +<li class="toctree-l2"><a class="reference internal" href="example1.html">Example 1 : First big step with SuMMIT</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Example 2 : Understanding the hyper-parameter optimization</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#hands-on-experience">Hands-on experience</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#example-2-1-no-hyper-parameter-optimization-impact-of-split-size">Example 2.1 : No hyper-parameter optimization, impact of split size</a></li> +<li class="toctree-l4"><a class="reference internal" href="#example-2-2-usage-of-randomized-hyper-parameter-optimization">Example 2.2 : Usage of randomized hyper-parameter optimization :</a></li> +<li class="toctree-l4"><a class="reference internal" href="#going-further-with-randomized-search">Going further with randomized search</a></li> +<li class="toctree-l4"><a class="reference internal" href="#example-2-3-usage-of-grid-search">Example 2.3 : Usage of grid search :</a></li> +<li class="toctree-l4"><a class="reference internal" href="#hyper-parameter-report">Hyper-parameter report</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="example3.html">Example 3 : Understanding the statistical iterations</a></li> +<li class="toctree-l2"><a class="reference internal" href="example4.html">Taking control : Use your own dataset</a></li> +<li class="toctree-l2"><a class="reference internal" href="example5.html">Taking control : Use your own algorithms</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html" class="icon icon-home"></a> »</li> + + <li><a href="index.html">SuMMIT Tutorials</a> »</li> + + <li>Example 2 : Understanding the hyper-parameter optimization</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/tutorials/example2.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="example-2-understanding-the-hyper-parameter-optimization"> <h1>Example 2 : Understanding the hyper-parameter optimization<a class="headerlink" href="#example-2-understanding-the-hyper-parameter-optimization" title="Permalink to this headline">¶</a></h1> @@ -432,84 +573,51 @@ splitter: best </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h3><a href="../index.html">Table of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Example 2 : Understanding the hyper-parameter optimization</a><ul> -<li><a class="reference internal" href="#hands-on-experience">Hands-on experience</a><ul> -<li><a class="reference internal" href="#example-2-1-no-hyper-parameter-optimization-impact-of-split-size">Example 2.1 : No hyper-parameter optimization, impact of split size</a><ul> -<li><a class="reference internal" href="#learning-on-a-few-samples">Learning on a few samples</a></li> -<li><a class="reference internal" href="#learning-on-more-samples">Learning on more samples</a></li> -<li><a class="reference internal" href="#conclusion">Conclusion</a></li> -</ul> -</li> -<li><a class="reference internal" href="#example-2-2-usage-of-randomized-hyper-parameter-optimization">Example 2.2 : Usage of randomized hyper-parameter optimization :</a><ul> -<li><a class="reference internal" href="#the-results">The results</a></li> -<li><a class="reference internal" href="#id2">Conclusion</a></li> -</ul> -</li> -<li><a class="reference internal" href="#going-further-with-randomized-search">Going further with randomized search</a></li> -<li><a class="reference internal" href="#example-2-3-usage-of-grid-search">Example 2.3 : Usage of grid search :</a></li> -<li><a class="reference internal" href="#hyper-parameter-report">Hyper-parameter report</a></li> -</ul> -</li> -</ul> -</li> -</ul> - - <h4>Previous topic</h4> - <p class="topless"><a href="example1.html" - title="previous chapter">Example 1 : First big step with SuMMIT</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="example3.html" - title="next chapter">Example 3 : Understanding the statistical iterations</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="../_sources/tutorials/example2.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="../search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="example3.html" class="btn btn-neutral float-right" title="Example 3 : Understanding the statistical iterations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="example1.html" class="btn btn-neutral float-left" title="Example 1 : First big step with SuMMIT" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example3.html" title="Example 3 : Understanding the statistical iterations" - >next</a> |</li> - <li class="right" > - <a href="example1.html" title="Example 1 : First big step with SuMMIT" - >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" >SuMMIT Tutorials</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/tutorials/index.html b/docs/build/tutorials/index.html index 5df481877b3d20969d4e566f5c15202c3b83d0ca..9af9c66217c3b502c37aa14fe51a725c704db0aa 100644 --- a/docs/build/tutorials/index.html +++ b/docs/build/tutorials/index.html @@ -1,51 +1,181 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>SuMMIT Tutorials — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>SuMMIT Tutorials — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Install SuMMIT" href="installation.html" /> <link rel="prev" title="Welcome to Supervised MultiModal Integration Tool’s documentation" href="../index.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="installation.html" title="Install SuMMIT" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="../index.html" title="Welcome to Supervised MultiModal Integration Tool’s documentation" - accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> SuMMIT + + + + + <img src="../_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">SuMMIT Tutorials</a><ul> +<li class="toctree-l2"><a class="reference internal" href="installation.html">Install SuMMIT</a></li> +<li class="toctree-l2"><a class="reference internal" href="example0.html">Example 0 : Getting started with SuMMIT on MNist</a></li> +<li class="toctree-l2"><a class="reference internal" href="example1.html">Example 1 : First big step with SuMMIT</a></li> +<li class="toctree-l2"><a class="reference internal" href="example2.html">Example 2 : Understanding the hyper-parameter optimization</a></li> +<li class="toctree-l2"><a class="reference internal" href="example3.html">Example 3 : Understanding the statistical iterations</a></li> +<li class="toctree-l2"><a class="reference internal" href="example4.html">Taking control : Use your own dataset</a></li> +<li class="toctree-l2"><a class="reference internal" href="example5.html">Taking control : Use your own algorithms</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html" class="icon icon-home"></a> »</li> + + <li>SuMMIT Tutorials</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/tutorials/index.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="summit-tutorials"> <h1>SuMMIT Tutorials<a class="headerlink" href="#summit-tutorials" title="Permalink to this headline">¶</a></h1> @@ -64,59 +194,51 @@ </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h4>Previous topic</h4> - <p class="topless"><a href="../index.html" - title="previous chapter">Welcome to Supervised MultiModal Integration Tool’s documentation</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="installation.html" - title="next chapter">Install SuMMIT</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="../_sources/tutorials/index.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="../search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="installation.html" class="btn btn-neutral float-right" title="Install SuMMIT" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../index.html" class="btn btn-neutral float-left" title="Welcome to Supervised MultiModal Integration Tool’s documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="installation.html" title="Install SuMMIT" - >next</a> |</li> - <li class="right" > - <a href="../index.html" title="Welcome to Supervised MultiModal Integration Tool’s documentation" - >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/build/tutorials/installation.html b/docs/build/tutorials/installation.html index 3eecbddd4584b5720f6cfccedc20cbcfbba069ee..cdfe8f788597093e1b57eade58ad83ebed8ccb01 100644 --- a/docs/build/tutorials/installation.html +++ b/docs/build/tutorials/installation.html @@ -1,52 +1,186 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Install SuMMIT — SuMMIT 0 documentation</title> - <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" /> + +<!DOCTYPE html> +<html class="writer-html4" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Install SuMMIT — SuMMIT 0 documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" /> + + + + + + + + + + + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + - <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/plotly_js.js"></script> + <script type="text/javascript" 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/plotly_js.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="Example 0 : Getting started with SuMMIT on digits" href="example0.html" /> + <link rel="next" title="Example 0 : Getting started with SuMMIT on MNist" href="example0.html" /> <link rel="prev" title="SuMMIT Tutorials" href="index.html" /> - </head><body> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - accesskey="I">index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example0.html" title="Example 0 : Getting started with SuMMIT on digits" - accesskey="N">next</a> |</li> - <li class="right" > - <a href="index.html" title="SuMMIT Tutorials" - accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">SuMMIT Tutorials</a> »</li> - </ul> - </div> - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> SuMMIT + + + + + <img src="../_static/logo_summit.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + 0.0.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">SuMMIT Tutorials</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Install SuMMIT</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#launching-the-setup-tool">Launching the setup tool</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="example0.html">Example 0 : Getting started with SuMMIT on MNist</a></li> +<li class="toctree-l2"><a class="reference internal" href="example1.html">Example 1 : First big step with SuMMIT</a></li> +<li class="toctree-l2"><a class="reference internal" href="example2.html">Example 2 : Understanding the hyper-parameter optimization</a></li> +<li class="toctree-l2"><a class="reference internal" href="example3.html">Example 3 : Understanding the statistical iterations</a></li> +<li class="toctree-l2"><a class="reference internal" href="example4.html">Taking control : Use your own dataset</a></li> +<li class="toctree-l2"><a class="reference internal" href="example5.html">Taking control : Use your own algorithms</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../api.html">API Documentation</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/monoview_classifiers/index.html">Available monoview classifiers</a></li> +<li class="toctree-l1"><a class="reference internal" href="../autoapi/summit/multiview_platform/multiview_classifiers/index.html">Available multiview classifiers</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">SuMMIT</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html" class="icon icon-home"></a> »</li> + + <li><a href="index.html">SuMMIT Tutorials</a> »</li> + + <li>Install SuMMIT</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/tutorials/installation.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> <div class="section" id="install-platf"> <h1>Install SuMMIT<a class="headerlink" href="#install-platf" title="Permalink to this headline">¶</a></h1> @@ -62,68 +196,51 @@ </div> + </div> + </div> - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> - <h3><a href="../index.html">Table of Contents</a></h3> - <ul> -<li><a class="reference internal" href="#">Install SuMMIT</a><ul> -<li><a class="reference internal" href="#launching-the-setup-tool">Launching the setup tool</a></li> -</ul> -</li> -</ul> - - <h4>Previous topic</h4> - <p class="topless"><a href="index.html" - title="previous chapter">SuMMIT Tutorials</a></p> - <h4>Next topic</h4> - <p class="topless"><a href="example0.html" - title="next chapter">Example 0 : Getting started with SuMMIT on digits</a></p> - <div role="note" aria-label="source link"> - <h3>This Page</h3> - <ul class="this-page-menu"> - <li><a href="../_sources/tutorials/installation.rst.txt" - rel="nofollow">Show Source</a></li> - </ul> - </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="../search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="example0.html" class="btn btn-neutral float-right" title="Example 0 : Getting started with SuMMIT on MNist" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="index.html" class="btn btn-neutral float-left" title="SuMMIT Tutorials" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>$('#searchbox').show(0);</script> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2019, Baptiste BAUVIN. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="related" role="navigation" aria-label="related navigation"> - <h3>Navigation</h3> - <ul> - <li class="right" style="margin-right: 10px"> - <a href="../genindex.html" title="General Index" - >index</a></li> - <li class="right" > - <a href="../py-modindex.html" title="Python Module Index" - >modules</a> |</li> - <li class="right" > - <a href="example0.html" title="Example 0 : Getting started with SuMMIT on digits" - >next</a> |</li> - <li class="right" > - <a href="index.html" title="SuMMIT Tutorials" - >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">SuMMIT 0 documentation</a> »</li> - <li class="nav-item nav-item-1"><a href="index.html" >SuMMIT Tutorials</a> »</li> - </ul> - </div> - <div class="footer" role="contentinfo"> - © Copyright 2019, Baptiste BAUVIN. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2. - </div> - </body> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> </html> \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 82190952429ff520f90ed83a7cadfc63faf7d6d1..2e41d81730824e1523f506b74fc4edab5dfd52fb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,6 +20,7 @@ # import os import sys +import sphinx_rtd_theme repo_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) @@ -44,6 +45,7 @@ add_module_names = False # ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.extlinks', + 'sphinx_rtd_theme', # 'sphinx.ext.doctest', # 'sphinx.ext.intersphinx', # 'sphinx.ext.todo', @@ -82,6 +84,8 @@ source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown'} # The master toctree document. master_doc = 'index' +html_logo = "logo_summit.png" + # General information about the project. project = u'SuMMIT' @@ -120,8 +124,9 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -# html_theme = 'sphinx_rtd_theme' -html_theme = 'classic' +html_theme = 'sphinx_rtd_theme' +# html_theme = 'classic' +# html_theme = 'groundwork' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/source/logo_summit.png b/docs/source/logo_summit.png new file mode 100644 index 0000000000000000000000000000000000000000..4f03112f4478ed4dc62978cdd271ee3706e7b9fa Binary files /dev/null and b/docs/source/logo_summit.png differ diff --git a/setup.py b/setup.py index 14527011e53270d9926d4fafa5da4af06fb912ac..c92d5a751bc330b121109cc60e2453977cce2baf 100644 --- a/setup.py +++ b/setup.py @@ -58,7 +58,8 @@ def setup_package(): install_requires=requirements, extras_require={ 'dev': ['pytest', 'pytest-cov'], - 'doc': ['sphinx >= 3.0.2', 'numpydoc', 'docutils', 'sphinx-autoapi']}, + 'doc': ['sphinx >= 3.0.2', 'numpydoc', 'docutils', 'sphinx-autoapi', + 'sphinx_rtd_theme']}, # Il est d'usage de mettre quelques metadata à propos de sa lib # Pour que les robots puissent facilement la classer.