From b8c5e863db6cd61814ac0f012f50b00acef64509 Mon Sep 17 00:00:00 2001
From: Baptiste Bauvin <baptiste.bauvin@lis-lab.fr>
Date: Wed, 19 Jun 2019 10:34:42 -0400
Subject: [PATCH] Added some doc on multiple arguments for monoview
---
README.md | 16 ++++++++++++++++
docs/source/analyzeresult.rst | 2 +-
docs/source/api.rst | 10 +++++-----
docs/source/conf.py | 2 +-
docs/source/execution.rst | 2 +-
docs/source/index.rst | 10 +++++-----
docs/source/monomulti/exec_classif.rst | 4 ++--
docs/source/monomulti/metrics.rst | 4 ++--
docs/source/monomultidoc.rst | 18 +++++++++---------
docs/source/readme.rst | 7 -------
docs/source/readme_link.rst | 4 ++++
11 files changed, 46 insertions(+), 33 deletions(-)
delete mode 100644 docs/source/readme.rst
create mode 100644 docs/source/readme_link.rst
diff --git a/README.md b/README.md
index faed06e0..604bd0ae 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,22 @@ In order to see all the arguments of this script, their description and default
cd multiview-machine-learning-omis/multiview_platform
python Exec.py -h
```
+The arguments can be passed through a file using `python Exec.py @<path_to_doc>`
+The file must be formatted with one newline instead of each space :
+Command line arguments `-debug --CL_type Monoview --CL_algos_monoview Adaboost SVM` will be formatted
+```
+-debug
+--CL_type
+Monoview
+--CL_algos_monoview
+Adaboost
+SVM
+```
+
+Moreover, for Monoview algorithms (Multiview is still WIP), it is possible to pass multiple arguments instead of just one.
+Thus, executing `python Exec.py --RF_trees 10 100 --RF_max_depth 3 4 --RF_criterion entropy` will result in the generation of several classifiers called
+`RandomForest_10_3_entropy`, with 10 trees and a max depth of 3, `RandomForest_10_4_entropy`, with 10 tress and a max depth of 4, `RandomForest_100_3_entropy`, `RandomForest_100_4_entropy` to test all the passed arguments combinations.
+
### Understanding `Results/` architecture
diff --git a/docs/source/analyzeresult.rst b/docs/source/analyzeresult.rst
index f2ca409b..2367d0d6 100644
--- a/docs/source/analyzeresult.rst
+++ b/docs/source/analyzeresult.rst
@@ -2,4 +2,4 @@ Result analysis module
======================
.. automodule:: multiview_platform.MonoMultiViewClassifiers.ResultAnalysis
-:members:
\ No newline at end of file
+ :members:
\ No newline at end of file
diff --git a/docs/source/api.rst b/docs/source/api.rst
index 6eec11bf..d5bc51ec 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -2,9 +2,9 @@ Multiview Platform
==================
.. toctree::
-:maxdepth: 1
- :caption: Contents:
+ :maxdepth: 1
+ :caption: Contents:
- execution
- monomultidoc
- analyzeresult
\ No newline at end of file
+ execution
+ monomultidoc
+ analyzeresult
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index dd872ce1..f3f304a1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -47,7 +47,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.napoleon',
- 'recommonmark']
+ 'm2r',]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
diff --git a/docs/source/execution.rst b/docs/source/execution.rst
index a1affdb1..3d26fece 100644
--- a/docs/source/execution.rst
+++ b/docs/source/execution.rst
@@ -2,5 +2,5 @@ Welcome to the exection documentation
=====================================
.. automodule:: multiview_platform.Exec
-:members:
+ :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
index c1f920fc..44a9136d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,4 +1,4 @@
-.. MultiviewPlatform documentation master file, created by
+MultiviewPlatform documentation master file, created by
sphinx-quickstart on Mon Jan 29 17:13:09 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
@@ -11,11 +11,11 @@ This package is used as an easy-to-use platform to estimate different mono- and
The main advantage of the platform is that it allows to add and remove a classifier without modifying its core code (the procedure is described thoroughly in this documentation).
.. toctree::
-:maxdepth: 3
- :caption: Contents:
+ :maxdepth: 3
+ :caption: Contents:
- readme
- api
+ readme_link
+ api
.. examples
diff --git a/docs/source/monomulti/exec_classif.rst b/docs/source/monomulti/exec_classif.rst
index 35a77fc4..fb379570 100644
--- a/docs/source/monomulti/exec_classif.rst
+++ b/docs/source/monomulti/exec_classif.rst
@@ -2,5 +2,5 @@ Classification execution module
===============================
.. automodule:: multiview_platform.MonoMultiViewClassifiers.ExecClassif
-:members:
- :inherited-members:
\ No newline at end of file
+ :members:
+ :inherited-members:
\ No newline at end of file
diff --git a/docs/source/monomulti/metrics.rst b/docs/source/monomulti/metrics.rst
index 46e97055..c42b38c4 100644
--- a/docs/source/monomulti/metrics.rst
+++ b/docs/source/monomulti/metrics.rst
@@ -2,5 +2,5 @@ Metrics framework
=================
.. automodule:: multiview_platform.MonoMultiViewClassifiers.Metrics.framework
-:members:
- :inherited-members:
\ No newline at end of file
+ :members:
+ :inherited-members:
\ No newline at end of file
diff --git a/docs/source/monomultidoc.rst b/docs/source/monomultidoc.rst
index 157b5f7e..b25fd849 100644
--- a/docs/source/monomultidoc.rst
+++ b/docs/source/monomultidoc.rst
@@ -2,13 +2,13 @@ Mono and mutliview classification
=================================
.. toctree::
-:maxdepth: 1
- :caption: Contents:
+ :maxdepth: 1
+ :caption: Contents:
- monomulti/metrics
- monomulti/monoview_classifier
- monomulti/multiview_classifier
- monomulti/exec_classif
- monomulti/multiview_classifiers/diversity_fusion
- monomulti/utils/execution
- monomulti/utils/multiclass
+ monomulti/metrics
+ monomulti/monoview_classifier
+ monomulti/multiview_classifier
+ monomulti/exec_classif
+ monomulti/multiview_classifiers/diversity_fusion
+ monomulti/utils/execution
+ monomulti/utils/multiclass
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
deleted file mode 100644
index 80d3e0a6..00000000
--- a/docs/source/readme.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Read me
-=======
-
-.. toctree::
-:maxdepth: 1
-
- ../../README.md
\ No newline at end of file
diff --git a/docs/source/readme_link.rst b/docs/source/readme_link.rst
new file mode 100644
index 00000000..c27a295c
--- /dev/null
+++ b/docs/source/readme_link.rst
@@ -0,0 +1,4 @@
+Readme
+======
+
+.. mdinclude:: ../../README.md
\ No newline at end of file
--
GitLab