diff --git a/docs/conf.py b/docs/conf.py
index d5a855ea5ff0889b4fa410e1c44e8eeca1ac0203..e2898b090fe16df72dedffc4c181b71884b36c3d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,8 +30,14 @@ release = '1.0.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'sphinx.ext.autodoc'
+ #'sphinx.ext.autosummary',
+ 'sphinx.ext.autodoc',
+ 'myst_parser'
]
+autodoc_default_flags = ['members']
+#autosummary_generate = True
+
+#add_module_names = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -52,4 +58,4 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
diff --git a/docs/expetator.benchmarks.rst b/docs/expetator.benchmarks.rst
index 9936a6e7cd0c4a154727e591fd6ce27bca3fa4b3..1f94251d9bf52757532c3cea7a1920acbe5a1c25 100644
--- a/docs/expetator.benchmarks.rst
+++ b/docs/expetator.benchmarks.rst
@@ -1,93 +1,25 @@
expetator.benchmarks package
============================
-Submodules
-----------
+.. autoclass:: expetator.benchmarks.cpubench.CpuBench
-expetator.benchmarks.genericbench module
-----------------------------------------
+.. autoclass:: expetator.benchmarks.genericbench.GenericBench
-.. automodule:: expetator.benchmarks.genericbench
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.benchmarks.gpucpubench.GpuCpuBench
-expetator.benchmarks.gpucpubench module
----------------------------------------
+.. autoclass:: expetator.benchmarks.gpumembench.GpuMemBench
-.. automodule:: expetator.benchmarks.gpucpubench
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.benchmarks.gromacsbench.GromacsBench
-expetator.benchmarks.gpumembench module
----------------------------------------
+.. autoclass:: expetator.benchmarks.membench.MemBench
-.. automodule:: expetator.benchmarks.gpumembench
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.benchmarks.mpibench.MpiBench
-expetator.benchmarks.gromacsbench module
-----------------------------------------
+.. autoclass:: expetator.benchmarks.npbbench.NpbBench
-.. automodule:: expetator.benchmarks.gromacsbench
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.benchmarks.percentagebench.PercentageBench
-expetator.benchmarks.membench module
-------------------------------------
+.. autoclass:: expetator.benchmarks.sleepbench.SleepBench
-.. automodule:: expetator.benchmarks.membench
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.benchmarks.watermark.WaterMark
-expetator.benchmarks.mpibench module
-------------------------------------
-
-.. automodule:: expetator.benchmarks.mpibench
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.benchmarks.npbbench module
-------------------------------------
-
-.. automodule:: expetator.benchmarks.npbbench
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.benchmarks.percentagebench module
--------------------------------------------
-
-.. automodule:: expetator.benchmarks.percentagebench
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.benchmarks.sleepbench module
---------------------------------------
-
-.. automodule:: expetator.benchmarks.sleepbench
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.benchmarks.watermark module
--------------------------------------
-
-.. automodule:: expetator.benchmarks.watermark
- :members:
- :undoc-members:
- :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.benchmarks
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/expetator.leverages.rst b/docs/expetator.leverages.rst
index 944565157944c17d0fc2d9eb9fc533ae38f0bb9c..15dbf1f02af7976ec28c5d0ccd90bbecedf9f245 100644
--- a/docs/expetator.leverages.rst
+++ b/docs/expetator.leverages.rst
@@ -1,77 +1,19 @@
expetator.leverages package
===========================
-Submodules
-----------
+.. autoclass:: expetator.leverages.dvfs.Dvfs
-expetator.leverages.dvfs module
--------------------------------
+.. autoclass:: expetator.leverages.gpuclock.GpuClock
-.. automodule:: expetator.leverages.dvfs
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.leverages.gpupow.GpuPower
-expetator.leverages.gpuclock module
------------------------------------
+.. autoclass:: expetator.leverages.neosched.NeoSched
-.. automodule:: expetator.leverages.gpuclock
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.leverages.nodeepsleep.Nodeepsleep
-expetator.leverages.gpupow module
----------------------------------
+.. autoclass:: expetator.leverages.pct.Pct
-.. automodule:: expetator.leverages.gpupow
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.leverages.powercap.Powercap
-expetator.leverages.neosched module
------------------------------------
+.. autoclass:: expetator.leverages.template.Template
-.. automodule:: expetator.leverages.neosched
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.leverages.nodeepsleep module
---------------------------------------
-
-.. automodule:: expetator.leverages.nodeepsleep
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.leverages.pct module
-------------------------------
-
-.. automodule:: expetator.leverages.pct
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.leverages.powercap module
------------------------------------
-
-.. automodule:: expetator.leverages.powercap
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.leverages.template module
------------------------------------
-
-.. automodule:: expetator.leverages.template
- :members:
- :undoc-members:
- :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.leverages
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/expetator.monitors.rst b/docs/expetator.monitors.rst
index b3235cbed32f26f1e8fc2f791c2ce04d54dc05c9..40124df3539a593c5e1bec3ca63ddc1cf9bb97f2 100644
--- a/docs/expetator.monitors.rst
+++ b/docs/expetator.monitors.rst
@@ -1,61 +1,10 @@
expetator.monitors package
==========================
-Submodules
-----------
+.. autoclass:: expetator.monitors.kwollect.Power
-expetator.monitors.kwollect module
-----------------------------------
+.. autoclass:: expetator.monitors.lperf.Lperf
-.. automodule:: expetator.monitors.kwollect
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.monitors.laptop\_power\_monitor module
-------------------------------------------------
-
-.. automodule:: expetator.monitors.laptop_power_monitor
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.monitors.lperf module
--------------------------------
-
-.. automodule:: expetator.monitors.lperf
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.monitors.mojitos module
----------------------------------
-
-.. automodule:: expetator.monitors.mojitos
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.monitors.power module
--------------------------------
-
-.. automodule:: expetator.monitors.power
- :members:
- :undoc-members:
- :show-inheritance:
-
-expetator.monitors.powergpu module
-----------------------------------
-
-.. automodule:: expetator.monitors.powergpu
- :members:
- :undoc-members:
- :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: expetator.monitors
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: expetator.monitors.mojitos.Mojitos
+
+.. autoclass:: expetator.monitors.powergpu.Power
diff --git a/docs/expetator.rst b/docs/expetator.rst
index d597df86f270ad3254f457850cb175bfd6b8021b..90373b1da2c61d507a0ccf0e020f44ae1fed0264 100644
--- a/docs/expetator.rst
+++ b/docs/expetator.rst
@@ -11,16 +11,8 @@ Subpackages
expetator.leverages
expetator.monitors
-Submodules
-----------
-
-expetator.add\_energy module
-----------------------------
-
-.. automodule:: expetator.add_energy
- :members:
- :undoc-members:
- :show-inheritance:
+Main modules
+------------
expetator.bundle module
-----------------------
@@ -30,14 +22,6 @@ expetator.bundle module
:undoc-members:
:show-inheritance:
-expetator.clean\_csv module
----------------------------
-
-.. automodule:: expetator.clean_csv
- :members:
- :undoc-members:
- :show-inheritance:
-
expetator.experiment module
---------------------------
@@ -46,14 +30,6 @@ expetator.experiment module
:undoc-members:
:show-inheritance:
-expetator.get\_nb\_freq module
-------------------------------
-
-.. automodule:: expetator.get_nb_freq
- :members:
- :undoc-members:
- :show-inheritance:
-
expetator.monitoring\_csv module
--------------------------------
@@ -94,10 +70,3 @@ expetator.watermark module
:undoc-members:
:show-inheritance:
-Module contents
----------------
-
-.. automodule:: expetator
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
index e475231d2ce76f86d3279add7ceaff1915367ddb..8b995ca7766dd718cd750c320943d4c0df932022 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,20 +1,14 @@
-.. Expetator documentation master file, created by
- sphinx-quickstart on Sun May 29 21:31:22 2022.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to Expetator's documentation!
-=============================
+Welcome to Expetator's documentation
+=====================================
.. toctree::
- :maxdepth: 2
- :caption: Contents:
+ :maxdepth: 4
+
+ expetator.benchmarks
+ expetator.leverages
+ expetator.monitors
- ../README.md
-Indices and tables
-==================
+.. include:: ../README.md
+ :parser: myst_parser.sphinx_
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/modules.rst b/docs/modules.rst
deleted file mode 100644
index acb8a59249cb95a5c57fb1da3f1757d00fb2345d..0000000000000000000000000000000000000000
--- a/docs/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-expetator
-=========
-
-.. toctree::
- :maxdepth: 4
-
- expetator
diff --git a/expetator/leverages/dvfs.py b/expetator/leverages/dvfs.py
index 2b5f3bec79e4db779b2ab6545b6e9c15563fd7bc..69ae3cde310817be7b8ccc42df7847b461798985 100644
--- a/expetator/leverages/dvfs.py
+++ b/expetator/leverages/dvfs.py
@@ -21,7 +21,17 @@ def get_dvfs_values():
return frequencies, pcts
class Dvfs:
- 'Cpufreq based DVFS'
+ """Cpufreq based DVFS
+
+ Detects all available frequencies and go through all of them
+
+ :param dummy: Only uses min and max frequency
+ :type dummy: bool
+ :param baseline: Only uses max frequency
+ :type baseline: bool
+ :param frequencies: Limits to the provided list of frequencies
+ :type frequencies: int list
+ """
def __init__(self, dummy=False, baseline=False, frequencies=None):
self.basedir = os.path.dirname(os.path.abspath(__file__))
self.dummy = dummy
@@ -30,7 +40,7 @@ class Dvfs:
self.available_frequencies = frequencies
def build(self, executor):
- 'Gather the available Frequenciess'
+ 'Gather the available Frequencies'
self.executor = executor
self.executor.hosts(self.basedir+'/dvfs_pct.sh init')
if self.available_frequencies is None: