Skip to content
Snippets Groups Projects
Commit 6a4df99c authored by Thomas Purcell's avatar Thomas Purcell
Browse files

Update the documentation

parent caa2a8cf
Branches
No related tags found
No related merge requests found
Showing
with 51 additions and 79 deletions
...@@ -5,8 +5,8 @@ Feature Creation ...@@ -5,8 +5,8 @@ Feature Creation
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Nodes Features
----- --------
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
......
.. _api_feat_space: .. _api_feat_space:
Feature Space
=============
.. toctree::
:maxdepth: 2
FeatureSpace FeatureSpace
------------ ------------
.. doxygenfile:: FeatureSpace.hpp .. doxygenfile:: FeatureSpace.hpp
......
.. _api_inputs: .. _api_inputs:
Input Parser
============
.. toctree::
:maxdepth: 2
InputParser InputParser
----------- -----------
.. doxygenfile:: InputParser.hpp .. doxygenfile:: InputParser.hpp
......
.. _api_math_utils: .. _api_math_utils:
Math Functions Math Utilities
============== ==============
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
math_funcs
----------
.. doxygenfile:: math_funcs.hpp .. doxygenfile:: math_funcs.hpp
:project: SISSO++ :project: SISSO++
.. _api_models: .. _api_models:
Models
======
.. toctree::
:maxdepth: 2
Model Model
----- -----
......
...@@ -5,7 +5,5 @@ Non-Linear Parameter Optimization ...@@ -5,7 +5,5 @@ Non-Linear Parameter Optimization
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
NLOptWrapper
------------
.. doxygenfile:: NLOptWrapper.hpp .. doxygenfile:: NLOptWrapper.hpp
:project: SISSO++ :project: SISSO++
.. _api_solvers: .. _api_solvers:
l0-Regularization Objects SISSOSolver
=========================
.. toctree::
:maxdepth: 2
SISSO_DI
-------- --------
.. doxygenfile:: SISSO_DI.hpp .. doxygenfile:: SISSOSolver.hpp
:project: SISSO++ :project: SISSO++
SISSOClassifier SISSOClassifier
......
# Contributing Guidelines # Contributing Guidelines
When contributing to this repository, please first discuss the change you wish to make via an issue, When contributing to this repository, please first discuss the change you wish to make via an issue, email, or any other method with the maintainers of this repository.
email, or any other method with the maintainers of this repository. This will make life easier for everyone. This will make life easier for everyone.
## Report Issues ## Report Issues
...@@ -17,4 +17,4 @@ Please use the [issue tracker](https://gitlab.com/sissopp-developers/sissopp/-/i ...@@ -17,4 +17,4 @@ Please use the [issue tracker](https://gitlab.com/sissopp-developers/sissopp/-/i
In order to contribute code to `SISSO++`, please use a merge request (see guidelines of preparing a merge request [here](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)). In order to contribute code to `SISSO++`, please use a merge request (see guidelines of preparing a merge request [here](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)).
- Please _document_ and _test_ your changes. Tests are found in `sissopp/tests` and written with [pytest](https://docs.pytest.org/en/stable/) for the python bindings and [googletest](https://github.com/google/googletest) for the C++ interface. - Please _document_ and _test_ your changes. Tests are found in `sissopp/tests` and written with [pytest](https://docs.pytest.org/en/stable/) for the python bindings and [googletest](https://github.com/google/googletest) for the C++ interface.
- If a new feature is introduced please create a minimal test of the binary file - If a new feature is introduced please create a minimal test of the binary file in `exec_tests`
...@@ -5,8 +5,8 @@ Feature Creation ...@@ -5,8 +5,8 @@ Feature Creation
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Nodes Features
----- --------
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
......
.. _py_api_feat_space: .. _py_api_feat_space:
Feature Space
=============
.. toctree::
:maxdepth: 2
FeatureSpace FeatureSpace
------------ ------------
.. autoclass:: sissopp.FeatureSpace .. autoclass:: sissopp.FeatureSpace
......
...@@ -10,8 +10,7 @@ Postprocessing ...@@ -10,8 +10,7 @@ Postprocessing
py_post_class py_post_class
py_post_load_model py_post_load_model
py_post_cv_check py_post_cv_check
py_post_feat_space_prev
py_post_plot_utils
py_post_cv_error
py_post_parity py_post_parity
py_post_map py_post_map
py_post_plot_utils
py_post_feat_space_prev
.. _py_api_models: .. _py_api_models:
Models
======
.. toctree::
:maxdepth: 2
Model Model
----- -----
.. autoclass:: sissopp.Model .. autoclass:: sissopp.Model
:special-members: __init__ :special-members: __init__
:members: :members:
...@@ -14,6 +10,9 @@ Model ...@@ -14,6 +10,9 @@ Model
ModelClassifier ModelClassifier
--------------- ---------------
.. currentmodule:: sissopp._sisso
.. autoclass:: sissopp.ModelClassifier .. autoclass:: sissopp.ModelClassifier
:special-members: __init__ :special-members: __init__
:members: :members:
...@@ -22,6 +21,9 @@ ModelClassifier ...@@ -22,6 +21,9 @@ ModelClassifier
ModelRegressor ModelRegressor
-------------- --------------
.. currentmodule:: sissopp._sisso
.. autoclass:: sissopp.ModelRegressor .. autoclass:: sissopp.ModelRegressor
:special-members: __init__ :special-members: __init__
:members: :members:
...@@ -30,6 +32,9 @@ ModelRegressor ...@@ -30,6 +32,9 @@ ModelRegressor
ModelLogRegressor ModelLogRegressor
----------------- -----------------
.. currentmodule:: sissopp._sisso
.. autoclass:: sissopp.ModelLogRegressor .. autoclass:: sissopp.ModelLogRegressor
:special-members: __init__ :special-members: __init__
:members: :members:
......
.. _py_api_node: .. _py_api_node:
Nodes
=====
.. toctree::
:maxdepth: 2
Node Node
---- ----
.. autoclass:: sissopp.Node .. autoclass:: sissopp.Node
......
...@@ -6,3 +6,7 @@ Classification ...@@ -6,3 +6,7 @@ Classification
.. currentmodule:: sissopp.postprocess.classification .. currentmodule:: sissopp.postprocess.classification
.. autofunction:: update_model_svm .. autofunction:: update_model_svm
.. currentmodule:: sissopp.postprocess.plot.classification
.. autofunction:: plot_classification
.. _py_api_cv_conv .. _py_api_cv_conv
Check Cross-Validation Convergence Cross-Validation Convergence
---------------------------------- ----------------------------
.. currentmodule:: sissopp.postprocess.check_cv_convergence .. currentmodule:: sissopp.postprocess.check_cv_convergence
.. autofunction:: jackknife_cv_conv_est .. autofunction:: jackknife_cv_conv_est
.. currentmodule:: sissopp.postprocess.plot.cv_error_plot
.. autofunction:: plot_validation_rmse
.. autofunction:: plot_errors_dists
.. autofunction:: add_violin
.. autofunction:: add_boxplot
.. autofunction:: add_pointplot
.. _py_api_post_cv_err
Cross-Validation Visualization
------------------------------
.. currentmodule:: sissopp.postprocess.cv_error_plot
.. autofunction:: plot_validation_rmse
.. autofunction:: plot_cv_errors
.. autofunction:: add_violin
.. autofunction:: add_boxplot
.. autofunction:: add_pointplot
...@@ -4,6 +4,6 @@ ...@@ -4,6 +4,6 @@
Plotting 2D Maps Plotting 2D Maps
---------------- ----------------
.. currentmodule:: sissopp.postprocess.maps .. currentmodule:: sissopp.postprocess.plot.maps
.. autofunction:: plot_2d_map .. autofunction:: plot_2d_map
...@@ -3,6 +3,6 @@ ...@@ -3,6 +3,6 @@
Parity Plots Parity Plots
------------ ------------
.. currentmodule:: sissopp.postprocess.parity_plot .. currentmodule:: sissopp.postprocess.plot.parity_plot
.. autofunction:: plot_model_parity_plot .. autofunction:: plot_model_parity_plot
...@@ -6,6 +6,7 @@ Reading Datafiles ...@@ -6,6 +6,7 @@ Reading Datafiles
.. currentmodule:: sissopp.py_interface.import_dataframe .. currentmodule:: sissopp.py_interface.import_dataframe
.. autofunction:: read_csv .. autofunction:: read_csv
.. autofunction:: create_inputs
.. autofunction:: extract_col .. autofunction:: extract_col
.. autofunction:: get_unit .. autofunction:: get_unit
.. autofunction:: strip_units .. autofunction:: strip_units
.. _py_api_solvers: .. _py_api_solvers:
l0-Regularization Objects .. currentmodule:: sissopp._sisso
=========================
.. toctree:: SISSOSolver
:maxdepth: 2 -----------
.. autoclass:: SISSOSolver
SISSO_DI
--------
.. autoclass:: sissopp.SISSO_DI
:special-members: __init__ :special-members: __init__
:members: :members:
:undoc-members: :undoc-members:
...@@ -15,7 +12,7 @@ SISSO_DI ...@@ -15,7 +12,7 @@ SISSO_DI
SISSOClassifier SISSOClassifier
--------------- ---------------
.. autoclass:: sissopp.SISSOClassifier .. autoclass:: SISSOClassifier
:special-members: __init__ :special-members: __init__
:members: :members:
:undoc-members: :undoc-members:
...@@ -23,7 +20,7 @@ SISSOClassifier ...@@ -23,7 +20,7 @@ SISSOClassifier
SISSORegressor SISSORegressor
-------------- --------------
.. autoclass:: sissopp.SISSORegressor .. autoclass:: SISSORegressor
:special-members: __init__ :special-members: __init__
:members: :members:
:undoc-members: :undoc-members:
...@@ -31,7 +28,7 @@ SISSORegressor ...@@ -31,7 +28,7 @@ SISSORegressor
SISSOLogRegressor SISSOLogRegressor
----------------- -----------------
.. autoclass:: sissopp.SISSOLogRegressor .. autoclass:: SISSOLogRegressor
:special-members: __init__ :special-members: __init__
:members: :members:
:undoc-members: :undoc-members:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment