diff --git a/README.md b/README.md index faed06e0249715aa82f8c2e7024d2e5e885c01e8..604bd0ae25e85dd8b0829dfb547cf5451e12cca1 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 f2ca409bdb82368a860b824e1c9734b45992d0c7..2367d0d6d17114b02e7ae8770033eb9810088785 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 6eec11bf9ce1a8700bdb0288296b12e4073c8231..d5bc51ec2f59e5cf9a482a0c29bfa8197f2b7703 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 dd872ce146c9059cb09d42b5bf215037f3e87dac..f3f304a15f51d16a586ecdba53437253a24699a9 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 a1affdb1af4cabf34b685bff05a1392802b3de72..3d26fece2aa89ea3212a2051624d9068f8e8b8fb 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 c1f920fca59f85d69efe6472e73fb2aa2a29cc1a..44a9136d33f0f540c21a696e5582ea3668cf5c84 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 35a77fc48659a7ae4abfaea0155ff2d99bcd7b57..fb379570eb8367796a8ecc95cd12877dcfb03d0b 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 46e970552d76dccbbd41ee80718817fe0c5578ca..c42b38c49b6529c78865f2ceacf212ae5b55f112 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 157b5f7e3fe1ae599514af2a428de4db8543bc13..b25fd849aaefb289724abedd80a1a95ee03d3938 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 80d3e0a6622a17419f888d8d85059751a6ab984d..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..c27a295c65fae03addd457470f676aff8a9c5b9d --- /dev/null +++ b/docs/source/readme_link.rst @@ -0,0 +1,4 @@ +Readme +====== + +.. mdinclude:: ../../README.md \ No newline at end of file