Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read the docs #96

Merged
merged 31 commits into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
752ac29
Create docs
steveyuwono Sep 15, 2021
e706097
Delete docs
steveyuwono Sep 15, 2021
d17e3ee
Create docs
steveyuwono Sep 15, 2021
90e7917
Delete docs
steveyuwono Sep 15, 2021
063986e
setup read the docs file
steveyuwono Sep 15, 2021
7a7dee6
setup read the docs file
steveyuwono Sep 15, 2021
ee58585
update read the docs
steveyuwono Sep 15, 2021
2d2db99
add README.rst to docs
steveyuwono Sep 16, 2021
a5a3025
add README.rst to docs
steveyuwono Sep 16, 2021
76cd2e1
add README.rst to docs
steveyuwono Sep 16, 2021
336aceb
add README.rst to docs
steveyuwono Sep 16, 2021
a5542ef
readme.rst on docs
steveyuwono Sep 16, 2021
c2f8c47
README.rst on docs
steveyuwono Sep 16, 2021
12792ba
latest html.rst
steveyuwono Sep 16, 2021
ecd090b
update edit on github target
steveyuwono Sep 17, 2021
feb88a1
make html update
steveyuwono Sep 17, 2021
443a312
del docs
steveyuwono Sep 19, 2021
cc3e03b
update readthedocs
steveyuwono Sep 19, 2021
befb9ec
readthedocs: readme.rst
steveyuwono Sep 19, 2021
42b5c4a
update read the docs - RL tutorial
steveyuwono Sep 20, 2021
45d9148
update read the docs : gt approach and how tos
steveyuwono Sep 20, 2021
1a1039b
update index.rst : readthedocs
steveyuwono Sep 20, 2021
01ed44f
docu updates: instructions for contributors
steveyuwono Sep 20, 2021
bdb4418
update read the docs : make html
steveyuwono Sep 20, 2021
209a402
update read the docs: mail mlpro
steveyuwono Sep 21, 2021
79bdd7d
update readthedocs: email and make html
steveyuwono Sep 22, 2021
464e2ff
readthedocs update, add components diagram
steveyuwono Sep 26, 2021
7575101
Readthedocs: format changed and updated components list
steveyuwono Sep 29, 2021
e0af3d5
update readthedocs: remove colons on chapters and bug fixing
steveyuwono Sep 29, 2021
c6f7d7d
docu update
steveyuwono Sep 29, 2021
a4a7484
minor update readthedocs (#5)
steveyuwono Oct 4, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions doc/docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
17 changes: 17 additions & 0 deletions doc/docs/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. image:: https://readthedocs.org/projects/mlpro/badge/?version=latest
:target: https://mlpro.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://badge.fury.io/py/mlpro.svg
:target: https://badge.fury.io/py/mlpro
:alt: mlpro on pypi

Documentation
================================================

Read MLPro documentation online at https://mlpro.readthedocs.io/

Optionally, to build the documentation yourself from the ``doc/docs/`` folder::

clone repository
open MLPro/doc/docs/_build/html/index.html on your browser
Binary file added doc/docs/_build/doctrees/README.doctree
Binary file not shown.
Binary file added doc/docs/_build/doctrees/environment.pickle
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/docs/_build/doctrees/index - Copy.doctree
Binary file not shown.
Binary file added doc/docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file added doc/docs/_build/doctrees/instructions/bf.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/docs/_build/doctrees/instructions/rl.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/docs/_build/doctrees/instructions/ui.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 4 additions & 0 deletions doc/docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: a29e7730842938a35bbbca9a58d8a591
tags: 645f666f9bcd5a90fca523b33c5a78b7
138 changes: 138 additions & 0 deletions doc/docs/_build/html/README.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation &mdash; MLPro Documentations 1.0.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/custom.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/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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"> MLPro Documentations<img src="_static/logo_fh-at.png" class="logo" alt="Logo"/>
</a>
<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="Navigation menu">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/intro/overview.html">What is MLPro?</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/intro/getstarted.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/intro/architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/intro/dependencies.html">Dependencies</a></li>
</ul>
<p class="caption"><span class="caption-text">MLPro-BF – Basic Functions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/bf/math.html">Mathematics</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/bf/ml.html">Machine Learning</a></li>
</ul>
<p class="caption"><span class="caption-text">MLPro-RL – Reinforcement Learning</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/agents.html">Agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/env.html">Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/scenario.html">Scenarios</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/pool.html">Pool</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/wrapper.html">3rd Party Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/rl/howto.html">Examples</a></li>
</ul>
<p class="caption"><span class="caption-text">MLPro-GT – Game Theory</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/gt/gt.html">Game Theory</a></li>
</ul>
<p class="caption"><span class="caption-text">MLPro-UI – Interactive ML</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/ui/sciui.html">UI Framework SciUI</a></li>
</ul>
<p class="caption"><span class="caption-text">Project MLPro</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instructions/project/versions.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/project/paper.html">Papers</a></li>
<li class="toctree-l1"><a class="reference internal" href="instructions/project/cont.html">Contribution</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MLPro Documentations</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/fhswf/MLPro/blob/main/doc/docs/README.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<a class="reference external image-reference" href="https://mlpro.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/mlpro/badge/?version=latest" /></a>
<a class="reference external image-reference" href="https://badge.fury.io/py/mlpro"><img alt="mlpro on pypi" src="https://badge.fury.io/py/mlpro.svg" /></a>
<div class="section" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<p>Read MLPro documentation online at <a class="reference external" href="https://mlpro.readthedocs.io/">https://mlpro.readthedocs.io/</a></p>
<p>Optionally, to build the documentation yourself from the <code class="docutils literal notranslate"><span class="pre">doc/docs/</span></code> folder:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">clone</span> <span class="n">repository</span>
<span class="nb">open</span> <span class="n">MLPro</span><span class="o">/</span><span class="n">doc</span><span class="o">/</span><span class="n">docs</span><span class="o">/</span><span class="n">_build</span><span class="o">/</span><span class="n">html</span><span class="o">/</span><span class="n">index</span><span class="o">.</span><span class="n">html</span> <span class="n">on</span> <span class="n">your</span> <span class="n">browser</span>
</pre></div>
</div>
</div>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021, FH-SWF AT.</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>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
17 changes: 17 additions & 0 deletions doc/docs/_build/html/_sources/README.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. image:: https://readthedocs.org/projects/mlpro/badge/?version=latest
:target: https://mlpro.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://badge.fury.io/py/mlpro.svg
:target: https://badge.fury.io/py/mlpro
:alt: mlpro on pypi

Documentation
================================================

Read MLPro documentation online at https://mlpro.readthedocs.io/

Optionally, to build the documentation yourself from the ``doc/docs/`` folder::

clone repository
open MLPro/doc/docs/_build/html/index.html on your browser
105 changes: 105 additions & 0 deletions doc/docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
.. MLPro Documentations documentation master file, created by
sphinx-quickstart on Wed Sep 15 12:06:53 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

MLPro - Machine Learning Professional
================================================

`MLPro <https://github.com/fhswf/MLPro.git>`_ is a synoptic framework for standardized machine learning tasks in Python!

MLPro was developed in 2021 by `Automation Technology team at Fachhochschule Südwestfalen <https://www.fh-swf.de/de/forschung___transfer_4/labore_3/labs/labor_fuer_automatisierungstechnik__soest_1/standardseite_57.php>`_.

MLPro provides complete, standardized, and reusable functionalities to support your scientific research or industrial project in machine learning.

In MLPro, we provide a standarized Python package for conducting research in reinforcement learning (RL) and game
theoretical (GT) approaches, including environments, algorithms, multi-agent RL (MARL), and many more. Additionally, we
enable our users to reuse the available packages by developing wrapper classes.

Moreover, MLPro focuses not only on Model-Free but also Model-Based RL problem.

Github repository: https://github.com/fhswf/MLPro.git


Main Contributions
--------------

- Test-driven development
- Clean code
- Ready-to-use functionalities
- Usability in scientific, industrial and educational contexts
- Extensible, maintainable, understandable
- Attractive UI support
- Reuse of available state-of-the-art implementations
- Clear documentations


Instructions for use
--------------

.. toctree::
:maxdepth: 2
:caption: Introduction

instructions/intro/overview
instructions/intro/getstarted
instructions/intro/architecture
instructions/intro/dependencies

.. toctree::
:maxdepth: 2
:caption: MLPro-BF – Basic Functions

instructions/bf/math
instructions/bf/ml

.. toctree::
:maxdepth: 3
:caption: MLPro-RL – Reinforcement Learning

instructions/rl/overview
instructions/rl/agents
instructions/rl/env
instructions/rl/scenario
instructions/rl/pool
instructions/rl/wrapper
instructions/rl/howto

.. toctree::
:maxdepth: 2
:caption: MLPro-GT – Game Theory

instructions/gt/gt

.. toctree::
:maxdepth: 2
:caption: MLPro-UI – Interactive ML

instructions/ui/sciui

.. toctree::
:maxdepth: 2
:caption: Project MLPro

instructions/project/versions
instructions/project/paper
instructions/project/cont

.. toctree::
:maxdepth: 2
:caption: Quick Help

instructions/project/help

Citing MLPro
------------------------
To cite this project in publications:

.. code-block:: bibtex

@misc{...
}

Contact Data
------------------------
Mail: mlpro@listen.fh-swf.de
26 changes: 26 additions & 0 deletions doc/docs/_build/html/_sources/instructions/bf/math.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Mathematics
================

`MLPro <https://github.com/fhswf/MLPro.git>`_ provides a module that consists of common
machine learning functionalities and properties. Additionally, you can also find modules
for basic mathematical classes and various classes with elementry functionalties to be
reused in higher level classes, for example: logging, load/save, timer, data storing, etc.

We provide :ref:`how to files<target-howto>` related to this subject.

This module includes Dimension, Set, Element, ElementList, MSpace, and Espace classes.

.. code-block:: bash

from mlpro.bf.math import *

Additional module includes load/save, logging, set timer, data storing, data loading, and
data plotting functionalities.


.. code-block:: bash

from mlpro.bf.various import *


Add text here!
19 changes: 19 additions & 0 deletions doc/docs/_build/html/_sources/instructions/bf/ml.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Machine Learning
================

This module includes hyperparameter setting, hyperparameter tuning, adaptive, and buffer
classes.

.. code-block:: bash

from mlpro.bf.ml import *


Add text here!


.. toctree::
:maxdepth: 1

ml/adapt
ml/tuning
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Adaptivity
-----------------------------------

Add text here!
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Hyperparameter Tuning
-----------------------------------

Add text here!
Loading