diff options
| author | Nathan Cassereau <84033440+ncassereau-idris@users.noreply.github.com> | 2021-12-09 17:55:12 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-09 17:55:12 +0100 |
| commit | f8d871e8c6f15009f559ece6a12eb8d8891c60fb (patch) | |
| tree | 9aa46b2fcc8046c6cddd8e9159a6f607dcf0e1e9 /docs | |
| parent | b3dc68feac355fa94c4237f4ecad65edc9f7a7e8 (diff) | |
[MRG] Tensorflow backend & Benchmarker & Myst_parser (#316)
* First batch of tf methods (to be continued)
* Second batch of method (yet to debug)
* tensorflow for cpu
* add tf requirement
* pep8 + bug
* small changes
* attempt to solve pymanopt bug with tf2
* attempt #2
* attempt #3
* attempt 4
* docstring
* correct pep8 violation introduced in merge conflicts resolution
* attempt 5
* attempt 6
* just a random try
* Revert "just a random try"
This reverts commit 8223e768bfe33635549fb66cca2267514a60ebbf.
* GPU tests for tensorflow
* pep8
* attempt to solve issue with m2r2
* Remove transpose backend method
* first draft of benchmarker (need to correct time measurement)
* prettier bench table
* Bitsize and prettier device methods
* prettified table bench
* Bug corrected (results were mixed up in the final table)
* Better perf counter (for GPU support)
* pep8
* EMD bench
* solve bug if no GPU available
* pep8
* warning about tensorflow numpy api being required in the backend.py docstring
* Bug solve in backend docstring
* not covering code which requires a GPU
* Tensorflow gradients manipulation tested
* Number of warmup runs is now customizable
* typo
* Remove some warnings while building docs
* Change prettier_device to device_type in backend
* Correct JAX mistakes preventing to see the CPU if a GPU is present
* Attempt to solve JAX bug in case no GPU is found
* Reworked benchmarks order and results storage & clear GPU after usage by benchmark
* Add bench to backend docstring
* better benchs
* remove useless stuff
* Better device_type
* Now using MYST_PARSER and solving links issue in the README.md / online docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | docs/requirements_rtd.txt | 2 | ||||
| -rw-r--r-- | docs/source/.github/CODE_OF_CONDUCT.rst | 6 | ||||
| -rw-r--r-- | docs/source/.github/CONTRIBUTING.rst | 6 | ||||
| -rw-r--r-- | docs/source/code_of_conduct.rst | 1 | ||||
| -rw-r--r-- | docs/source/conf.py | 2 | ||||
| -rw-r--r-- | docs/source/contributing.rst | 1 | ||||
| -rw-r--r-- | docs/source/index.rst | 9 |
8 files changed, 19 insertions, 10 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt index 95147d2..2e060b9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,4 +4,4 @@ numpydoc memory_profiler pillow networkx -m2r2
\ No newline at end of file +myst-parser
\ No newline at end of file diff --git a/docs/requirements_rtd.txt b/docs/requirements_rtd.txt index 5963ea2..11957fb 100644 --- a/docs/requirements_rtd.txt +++ b/docs/requirements_rtd.txt @@ -3,7 +3,7 @@ numpydoc memory_profiler pillow networkx -m2r2 +myst-parser numpy scipy>=1.0 cython diff --git a/docs/source/.github/CODE_OF_CONDUCT.rst b/docs/source/.github/CODE_OF_CONDUCT.rst new file mode 100644 index 0000000..d4c5cec --- /dev/null +++ b/docs/source/.github/CODE_OF_CONDUCT.rst @@ -0,0 +1,6 @@ +Code of Conduct +=============== + +.. include:: ../../../.github/CODE_OF_CONDUCT.md + :parser: myst_parser.sphinx_ + :start-line: 2 diff --git a/docs/source/.github/CONTRIBUTING.rst b/docs/source/.github/CONTRIBUTING.rst new file mode 100644 index 0000000..aef24e9 --- /dev/null +++ b/docs/source/.github/CONTRIBUTING.rst @@ -0,0 +1,6 @@ +Contributing to POT +=================== + +.. include:: ../../../.github/CONTRIBUTING.md + :parser: myst_parser.sphinx_ + :start-line: 3 diff --git a/docs/source/code_of_conduct.rst b/docs/source/code_of_conduct.rst deleted file mode 100644 index b37ba7b..0000000 --- a/docs/source/code_of_conduct.rst +++ /dev/null @@ -1 +0,0 @@ -.. mdinclude:: ../../.github/CODE_OF_CONDUCT.md
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 1320afa..849e97c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,7 +69,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinx_gallery.gen_gallery', - 'm2r2' + 'myst_parser' ] autosummary_generate = True diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst deleted file mode 100644 index dc81e75..0000000 --- a/docs/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. mdinclude:: ../../.github/CONTRIBUTING.md
\ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 7aaa524..8de31ae 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,12 +17,11 @@ Contents all auto_examples/index releases - contributing - Code of Conduct <code_of_conduct> - -.. mdinclude:: ../../README.md - :start-line: 2 + .github/CONTRIBUTING + .github/CODE_OF_CONDUCT +.. include:: ../../README.md + :parser: myst_parser.sphinx_ Indices and tables |