From 8d171f1cd9236168610653423e09576fb195f53a Mon Sep 17 00:00:00 2001 From: Vasileios Karakasis Date: Fri, 12 Nov 2021 19:13:54 +0100 Subject: [PATCH] Fix test library docs --- cscs-checks/apps/jupyter/check_ipcmagic.py | 2 +- cscs-checks/apps/spark/spark_check.py | 2 +- docs/hpctestlib.rst | 14 +++++++++++--- .../{compute_pi/__init__.py => spark_checks.py} | 2 +- .../spark/{compute_pi => }/src/spark_pi.py | 0 .../jupyter/ipcmagic/__init__.py | 0 .../jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py | 0 7 files changed, 14 insertions(+), 6 deletions(-) rename hpctestlib/data_analytics/spark/{compute_pi/__init__.py => spark_checks.py} (99%) rename hpctestlib/data_analytics/spark/{compute_pi => }/src/spark_pi.py (100%) rename hpctestlib/{sciapps => interactive}/jupyter/ipcmagic/__init__.py (100%) rename hpctestlib/{sciapps => interactive}/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py (100%) diff --git a/cscs-checks/apps/jupyter/check_ipcmagic.py b/cscs-checks/apps/jupyter/check_ipcmagic.py index 16667d1301..5fb1922554 100644 --- a/cscs-checks/apps/jupyter/check_ipcmagic.py +++ b/cscs-checks/apps/jupyter/check_ipcmagic.py @@ -5,7 +5,7 @@ import reframe as rfm -from hpctestlib.sciapps.jupyter.ipcmagic import ipcmagic_check +from hpctestlib.interactive.jupyter.ipcmagic import ipcmagic_check @rfm.simple_test diff --git a/cscs-checks/apps/spark/spark_check.py b/cscs-checks/apps/spark/spark_check.py index 5b59176b25..0dfbeca127 100644 --- a/cscs-checks/apps/spark/spark_check.py +++ b/cscs-checks/apps/spark/spark_check.py @@ -5,7 +5,7 @@ import reframe as rfm -from hpctestlib.data_analytics.spark.compute_pi import compute_pi_check +from hpctestlib.data_analytics.spark.spark_checks import compute_pi_check @rfm.simple_test diff --git a/docs/hpctestlib.rst b/docs/hpctestlib.rst index c074af1c29..6124da209b 100644 --- a/docs/hpctestlib.rst +++ b/docs/hpctestlib.rst @@ -7,7 +7,15 @@ This is a collection of generic tests that you can either run out-of-the-box by Scientific Applications ----------------------- -.. automodule:: hpctestlib.apps.amber.nve +.. automodule:: hpctestlib.sciapps.amber.nve + :members: + :show-inheritance: + + +Data Analytics +-------------- + +.. automodule:: hpctestlib.data_analytics.spark.spark_checks :members: :show-inheritance: @@ -21,8 +29,8 @@ Python Interactive Computing ------------------------ +--------------------- -.. automodule:: hpctestlib.apps.jupyter.ipcmagic +.. automodule:: hpctestlib.interactive.jupyter.ipcmagic :members: :show-inheritance: diff --git a/hpctestlib/data_analytics/spark/compute_pi/__init__.py b/hpctestlib/data_analytics/spark/spark_checks.py similarity index 99% rename from hpctestlib/data_analytics/spark/compute_pi/__init__.py rename to hpctestlib/data_analytics/spark/spark_checks.py index be6d7c839f..d0673956b1 100644 --- a/hpctestlib/data_analytics/spark/compute_pi/__init__.py +++ b/hpctestlib/data_analytics/spark/spark_checks.py @@ -35,7 +35,7 @@ class compute_pi_check(rfm.RunOnlyRegressionTest, pin_prefix=True): #: Parameter encoding the variant of the test. #: - #: :type:`str` + #: :type: :class:`str` #: :values: ``['spark', 'pyspark']`` variant = parameter(['spark', 'pyspark']) diff --git a/hpctestlib/data_analytics/spark/compute_pi/src/spark_pi.py b/hpctestlib/data_analytics/spark/src/spark_pi.py similarity index 100% rename from hpctestlib/data_analytics/spark/compute_pi/src/spark_pi.py rename to hpctestlib/data_analytics/spark/src/spark_pi.py diff --git a/hpctestlib/sciapps/jupyter/ipcmagic/__init__.py b/hpctestlib/interactive/jupyter/ipcmagic/__init__.py similarity index 100% rename from hpctestlib/sciapps/jupyter/ipcmagic/__init__.py rename to hpctestlib/interactive/jupyter/ipcmagic/__init__.py diff --git a/hpctestlib/sciapps/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py b/hpctestlib/interactive/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py similarity index 100% rename from hpctestlib/sciapps/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py rename to hpctestlib/interactive/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.py