Skip to content

Commit

Permalink
- (docs) polishing pySIPFENN Tests docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
amkrajewski committed Oct 25, 2023
1 parent 3e5f57c commit 24f2fa3
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions docs/source/pysipfenn.tests.rst
Original file line number Diff line number Diff line change
@@ -1,68 +1,64 @@
pySIPFENN Tests
===============

Tests Core pySIPFENN functionalities
------------------------------------
Core pySIPFENN Functionalities
------------------------------

.. automodule:: pysipfenn.tests.test_pysipfenn
:members:
:undoc-members:
:show-inheritance:

Tests KS2022 featurization
--------------------------
KS2022 Featurization Correctness
--------------------------------

.. automodule:: pysipfenn.tests.test_KS2022
:members:
:undoc-members:
:show-inheritance:

Tests KS2022 featurization with dilute optimization
---------------------------------------------------
KS2022 Dilute-Optimized Featurization Correctness
-------------------------------------------------

.. automodule:: pysipfenn.tests.test_KS2022_dilute
:members:
:undoc-members:
:show-inheritance:

Tests Ward2017 featurization
----------------------------
Ward2017 Featurization Correctness
----------------------------------

.. automodule:: pysipfenn.tests.test_Ward2017
:members:
:undoc-members:
:show-inheritance:

Runtime of all compatible ONNX models with Ward2017 featurization
-----------------------------------------------------------------

(on all example input files)
Auto Runtime of All ONNX Models with Ward2017
---------------------------------------------

.. automodule:: pysipfenn.tests.test_AllCompatibleONNX_Ward2017
:members:
:undoc-members:
:show-inheritance:

Accuracy of NN9/20/24 predictions against reference
Accuracy of NN9 20 24 Predictions Against Reference
---------------------------------------------------

(one example Sigma-phase endmember)

.. automodule:: pysipfenn.tests.test_Krajewski2020_NN9NN20NN24_ONNX
:members:
:undoc-members:
:show-inheritance:

Test Model Exporters
--------------------
Model Exporters Runtime
-----------------------

.. automodule:: pysipfenn.tests.test_ModelExporters
:members:
:undoc-members:
:show-inheritance:

Test Defining Custom Models
---------------------------
Defining Custom Models
----------------------

.. automodule:: pysipfenn.tests.test_customModel
:members:
Expand Down

0 comments on commit 24f2fa3

Please sign in to comment.