Update Python API with python only functions

DocStrings match new python structure

docs/python_api/py_Interface.rst

+.. _py_api_interface:
+
+Python Interface
+================
+.. toctree::
+    :maxdepth: 2
+
+    py_reading_data_files
+    py_constructing_solvers
+    py_estimate_feature_space_size

docs/python_api/py_Postprocessing

-.. _py_api_di:
-
-Utilities
-=========
-.. toctree::
-    :maxdepth: 2
-
-Classification
---------------
-.. toctree::
-    :maxdepth: 2
-
-    .. autofunction:: sissopp.classification.svm.update_model_svm
-
-

docs/python_api/py_Postprocessing.rst

+.. _py_api_post:
+
+.. currentmodule:: sissopp.postprocess
+
+Postprocessing
+==============
+.. toctree::
+    :maxdepth: 2
+
+    py_post_class
+    py_post_load_model
+    py_post_cv_check
+    py_post_feat_space_prev
+    py_post_plot_utils
+    py_post_cv_error
+    py_post_parity
+    py_post_map

docs/python_api/py_Utilities

-.. _py_api_di:
-
-Utilities
-=========
-.. toctree::
-    :maxdepth: 2
-
-Classification
---------------
-.. toctree::
-    :maxdepth: 2
-
-    .. autofunction:: sissopp.classification.svm.update_model_svm

docs/python_api/py_constructing_solvers.rst

+.. _py_api_get_solvers
+
+
+Constructing Solvers
+--------------------
+
+.. currentmodule:: sissopp.py_interface.get_solver
+
+.. autofunction:: get_fs
+.. autofunction:: get_fs_solver

docs/python_api/py_estimate_feature_space_size.rst

+.. _py_api_est_feat_space
+
+
+Estimate Feature Space Size
+---------------------------
+
+.. currentmodule:: sissopp.py_interface.estimate_feat_space_size
+
+.. autofunction:: get_max_number_feats
+.. autofunction:: get_estimate_n_feat_next_rung

docs/python_api/py_post_class.rst

+.. _py_api_class
+
+Classification
+--------------
+
+.. currentmodule:: sissopp.postprocess.classification
+
+.. autofunction:: update_model_svm

docs/python_api/py_post_cv_check.rst

+.. _py_api_cv_conv
+
+
+Check Cross-Validation Convergence
+----------------------------------
+
+.. currentmodule:: sissopp.postprocess.check_cv_convergence
+
+.. autofunction:: jackknife_cv_conv_est

docs/python_api/py_post_cv_error.rst

+.. _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

docs/python_api/py_post_feat_space_prev.rst

+.. _py_api_post_an_fs
+
+
+Feature Space Analysis
+----------------------
+
+.. currentmodule:: sissopp.postprocess.feature_space_analysis
+
+.. autofunction:: get_prevelance_of_primary_features

docs/python_api/py_post_load_model.rst

+.. _py_api_load_models
+
+Load Models
+-----------
+
+.. currentmodule:: sissopp.postprocess.load_models
+
+.. autofunction:: sort_model_file_key
+.. autofunction:: load_model
+.. autofunction:: get_models
+.. autofunction:: create_model_csv

docs/python_api/py_post_map.rst

+.. _py_api_post_map
+
+
+Plotting 2D Maps
+----------------
+
+.. currentmodule:: sissopp.postprocess.maps
+
+.. autofunction:: plot_2d_map

docs/python_api/py_post_parity.rst

+.. _py_api_post_parity
+
+Parity Plots
+------------
+
+.. currentmodule:: sissopp.postprocess.parity_plot
+
+.. autofunction:: plot_model_parity_plot

docs/python_api/py_post_plot_utils.rst

+.. _py_api_post_plot_utils
+
+Plotting Utilities
+------------------
+
+.. currentmodule:: sissopp.postprocess.plot.utils
+
+.. autofunction:: setup_plot_ax
+.. autofunction:: adjust_box_widths
+.. autofunction:: latexify

docs/python_api/py_reading_data_files.rst

+.. _py_api_read_data
+
+Reading Datafiles
+-----------------
+
+.. currentmodule:: sissopp.py_interface.import_dataframe
+
+.. autofunction:: read_csv
+.. autofunction:: extract_col
+.. autofunction:: get_unit
+.. autofunction:: strip_units

docs/python_api/python_api.rst

@@ -5,7 +5,7 @@ Python API
 .. toctree::
     :maxdepth: 2
 
-    py_PythonInterface
+    py_Interface
     py_FeatureCreation
     py_DescriptorIdentification
     py_Postprocessing

src/python/postprocess/check_cv_convergence.py

@@ -30,8 +30,9 @@ def jackknife_cv_conv_est(models):
         models (str or list of Models): Models to evaluate
 
     Returns:
-        avg_error (np.ndarray): The average rmse of the test error
-        variance (np.ndarray): The jackknife estimate of the variance of the test RMSE
+        tuple: A tuple containing:
+            - avg_error (np.ndarray): The average rmse of the test error
+            - variance (np.ndarray): The jackknife estimate of the variance of the test RMSE
     """
     if isinstance(models, str):
         models = get_models(models)

src/python/postprocess/classification.py

@@ -33,7 +33,7 @@ def update_model_svm(model, c=1.0, max_iter=-1, tol=0.0001, filename=None):
         filename (str): Filename to store the updated model
 
     Returns:
-        new_model (ModelClassifier): The updated model with better SVM parameters
+        ModelClassifier: The updated model with better SVM parameters
     """
     if isinstance(model, str):
         model = ModelClassifier(model)

src/python/postprocess/load_models.py

@@ -108,7 +108,7 @@ def create_model_csv(df, model, filename=None):
         filename (str): The filename to print the new csv file to
 
     Returns:
-        df_red (pd.DataFrame): The reduced data file
+        pd.DataFrame: The reduced data file
     """
     df = strip_units(df)
 

src/python/postprocess/plot/__init__.py

@@ -11,7 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-             """Create various plots of the SISSO models
+"""Create various plots of the SISSO models
 
 Modules: