diff --git a/docs/expetator.rst b/docs/expetator.rst index 90373b1da2c61d507a0ccf0e020f44ae1fed0264..334953b0c95bbdca43b74a7fb2b69305f7e84979 100644 --- a/docs/expetator.rst +++ b/docs/expetator.rst @@ -1,72 +1,18 @@ -expetator package -================= +Expetator +========= -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - expetator.benchmarks - expetator.leverages - expetator.monitors - -Main modules ------------- - -expetator.bundle module ------------------------ - -.. automodule:: expetator.bundle - :members: - :undoc-members: - :show-inheritance: - -expetator.experiment module ---------------------------- +Starting an experiment +---------------------- .. automodule:: expetator.experiment - :members: - :undoc-members: - :show-inheritance: + :members: run_experiment -expetator.monitoring\_csv module --------------------------------- +Interaction with the platform +----------------------------- -.. automodule:: expetator.monitoring_csv +.. autoclass:: expetator.experiment.Executor :members: :undoc-members: - :show-inheritance: -expetator.monitoring\_list module ---------------------------------- - -.. automodule:: expetator.monitoring_list - :members: - :undoc-members: - :show-inheritance: - -expetator.remove\_watermark module ----------------------------------- - -.. automodule:: expetator.remove_watermark - :members: - :undoc-members: - :show-inheritance: - -expetator.tools module ----------------------- - -.. automodule:: expetator.tools - :members: - :undoc-members: - :show-inheritance: - -expetator.watermark module --------------------------- - -.. automodule:: expetator.watermark - :members: - :undoc-members: - :show-inheritance: +