Sphinx docs: initial commit

ASvyatkovskiy · ASvyatkovskiy · commit 3e667cd52b2e · 2017-02-19T12:58:24.000-05:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,20 @@
+.. plasma documentation master file, created by
+   sphinx-quickstart on Fri Feb 17 22:20:28 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to plasma's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/plasma.models.builder.LossHistory.rst b/docs/plasma.models.builder.LossHistory.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.builder.LossHistory
+=================================
+
+.. autoclass:: plasma.models.builder.LossHistory
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.builder.ModelBuilder.rst b/docs/plasma.models.builder.ModelBuilder.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.builder.ModelBuilder
+==================================
+
+.. autoclass:: plasma.models.builder.ModelBuilder
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.loader.Loader.rst b/docs/plasma.models.loader.Loader.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.loader.Loader
+===========================
+
+.. autoclass:: plasma.models.loader.Loader
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.Averager.rst b/docs/plasma.models.mpi_runner.Averager.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.mpi_runner.Averager
+=================================
+
+.. autoclass:: plasma.models.mpi_runner.Averager
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.MPIAdam.rst b/docs/plasma.models.mpi_runner.MPIAdam.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.mpi_runner.MPIAdam
+================================
+
+.. autoclass:: plasma.models.mpi_runner.MPIAdam
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.MPIModel.rst b/docs/plasma.models.mpi_runner.MPIModel.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.mpi_runner.MPIModel
+=================================
+
+.. autoclass:: plasma.models.mpi_runner.MPIModel
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.MPIOptimizer.rst b/docs/plasma.models.mpi_runner.MPIOptimizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.mpi_runner.MPIOptimizer
+=====================================
+
+.. autoclass:: plasma.models.mpi_runner.MPIOptimizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.MPISGD.rst b/docs/plasma.models.mpi_runner.MPISGD.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.mpi_runner.MPISGD
+===============================
+
+.. autoclass:: plasma.models.mpi_runner.MPISGD
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.mpi_runner.add_params.rst b/docs/plasma.models.mpi_runner.add_params.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.add_params
+===================================
+
+.. autofunction:: plasma.models.mpi_runner.add_params
diff --git a/docs/plasma.models.mpi_runner.get_shot_list_path.rst b/docs/plasma.models.mpi_runner.get_shot_list_path.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.get_shot_list_path
+===========================================
+
+.. autofunction:: plasma.models.mpi_runner.get_shot_list_path
diff --git a/docs/plasma.models.mpi_runner.load_shotlists.rst b/docs/plasma.models.mpi_runner.load_shotlists.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.load_shotlists
+=======================================
+
+.. autofunction:: plasma.models.mpi_runner.load_shotlists
diff --git a/docs/plasma.models.mpi_runner.mpi_make_predictions.rst b/docs/plasma.models.mpi_runner.mpi_make_predictions.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.mpi_make_predictions
+=============================================
+
+.. autofunction:: plasma.models.mpi_runner.mpi_make_predictions
diff --git a/docs/plasma.models.mpi_runner.mpi_make_predictions_and_evaluate.rst b/docs/plasma.models.mpi_runner.mpi_make_predictions_and_evaluate.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.mpi_make_predictions_and_evaluate
+==========================================================
+
+.. autofunction:: plasma.models.mpi_runner.mpi_make_predictions_and_evaluate
diff --git a/docs/plasma.models.mpi_runner.mpi_train.rst b/docs/plasma.models.mpi_runner.mpi_train.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.mpi_train
+==================================
+
+.. autofunction:: plasma.models.mpi_runner.mpi_train
diff --git a/docs/plasma.models.mpi_runner.multiply_params.rst b/docs/plasma.models.mpi_runner.multiply_params.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.multiply_params
+========================================
+
+.. autofunction:: plasma.models.mpi_runner.multiply_params
diff --git a/docs/plasma.models.mpi_runner.print_all.rst b/docs/plasma.models.mpi_runner.print_all.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.print_all
+==================================
+
+.. autofunction:: plasma.models.mpi_runner.print_all
diff --git a/docs/plasma.models.mpi_runner.print_unique.rst b/docs/plasma.models.mpi_runner.print_unique.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.print_unique
+=====================================
+
+.. autofunction:: plasma.models.mpi_runner.print_unique
diff --git a/docs/plasma.models.mpi_runner.save_shotlists.rst b/docs/plasma.models.mpi_runner.save_shotlists.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.save_shotlists
+=======================================
+
+.. autofunction:: plasma.models.mpi_runner.save_shotlists
diff --git a/docs/plasma.models.mpi_runner.subtract_params.rst b/docs/plasma.models.mpi_runner.subtract_params.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.mpi_runner.subtract_params
+========================================
+
+.. autofunction:: plasma.models.mpi_runner.subtract_params
diff --git a/docs/plasma.models.runner.make_evaluations_gpu.rst b/docs/plasma.models.runner.make_evaluations_gpu.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.make_evaluations_gpu
+=========================================
+
+.. autofunction:: plasma.models.runner.make_evaluations_gpu
diff --git a/docs/plasma.models.runner.make_predictions.rst b/docs/plasma.models.runner.make_predictions.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.make_predictions
+=====================================
+
+.. autofunction:: plasma.models.runner.make_predictions
diff --git a/docs/plasma.models.runner.make_predictions_and_evaluate_gpu.rst b/docs/plasma.models.runner.make_predictions_and_evaluate_gpu.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.make_predictions_and_evaluate_gpu
+======================================================
+
+.. autofunction:: plasma.models.runner.make_predictions_and_evaluate_gpu
diff --git a/docs/plasma.models.runner.make_predictions_gpu.rst b/docs/plasma.models.runner.make_predictions_gpu.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.make_predictions_gpu
+=========================================
+
+.. autofunction:: plasma.models.runner.make_predictions_gpu
diff --git a/docs/plasma.models.runner.make_single_prediction.rst b/docs/plasma.models.runner.make_single_prediction.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.make_single_prediction
+===========================================
+
+.. autofunction:: plasma.models.runner.make_single_prediction
diff --git a/docs/plasma.models.runner.plot_losses.rst b/docs/plasma.models.runner.plot_losses.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.plot_losses
+================================
+
+.. autofunction:: plasma.models.runner.plot_losses
diff --git a/docs/plasma.models.runner.train.rst b/docs/plasma.models.runner.train.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.models.runner.train
+==========================
+
+.. autofunction:: plasma.models.runner.train
diff --git a/docs/plasma.models.targets.BinaryTarget.rst b/docs/plasma.models.targets.BinaryTarget.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.targets.BinaryTarget
+==================================
+
+.. autoclass:: plasma.models.targets.BinaryTarget
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.targets.HingeTarget.rst b/docs/plasma.models.targets.HingeTarget.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.targets.HingeTarget
+=================================
+
+.. autoclass:: plasma.models.targets.HingeTarget
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.targets.TTDLinearTarget.rst b/docs/plasma.models.targets.TTDLinearTarget.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.targets.TTDLinearTarget
+=====================================
+
+.. autoclass:: plasma.models.targets.TTDLinearTarget
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.targets.TTDTarget.rst b/docs/plasma.models.targets.TTDTarget.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.targets.TTDTarget
+===============================
+
+.. autoclass:: plasma.models.targets.TTDTarget
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.models.targets.Target.rst b/docs/plasma.models.targets.Target.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.models.targets.Target
+============================
+
+.. autoclass:: plasma.models.targets.Target
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.AveragingVarNormalizer.rst b/docs/plasma.preprocessor.normalize.AveragingVarNormalizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.AveragingVarNormalizer
+====================================================
+
+.. autoclass:: plasma.preprocessor.normalize.AveragingVarNormalizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.MeanVarNormalizer.rst b/docs/plasma.preprocessor.normalize.MeanVarNormalizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.MeanVarNormalizer
+===============================================
+
+.. autoclass:: plasma.preprocessor.normalize.MeanVarNormalizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.MinMaxNormalizer.rst b/docs/plasma.preprocessor.normalize.MinMaxNormalizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.MinMaxNormalizer
+==============================================
+
+.. autoclass:: plasma.preprocessor.normalize.MinMaxNormalizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.Normalizer.rst b/docs/plasma.preprocessor.normalize.Normalizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.Normalizer
+========================================
+
+.. autoclass:: plasma.preprocessor.normalize.Normalizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.Stats.rst b/docs/plasma.preprocessor.normalize.Stats.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.Stats
+===================================
+
+.. autoclass:: plasma.preprocessor.normalize.Stats
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.VarNormalizer.rst b/docs/plasma.preprocessor.normalize.VarNormalizer.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.normalize.VarNormalizer
+===========================================
+
+.. autoclass:: plasma.preprocessor.normalize.VarNormalizer
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.preprocessor.normalize.get_individual_shot_file.rst b/docs/plasma.preprocessor.normalize.get_individual_shot_file.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+plasma.preprocessor.normalize.get_individual_shot_file
+======================================================
+
+.. autofunction:: plasma.preprocessor.normalize.get_individual_shot_file
diff --git a/docs/plasma.preprocessor.preprocess.Preprocessor.rst b/docs/plasma.preprocessor.preprocess.Preprocessor.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.preprocessor.preprocess.Preprocessor
+===========================================
+
+.. autoclass:: plasma.preprocessor.preprocess.Preprocessor
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.primitives.shots.Shot.rst b/docs/plasma.primitives.shots.Shot.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.primitives.shots.Shot
+============================
+
+.. autoclass:: plasma.primitives.shots.Shot
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.primitives.shots.ShotList.rst b/docs/plasma.primitives.shots.ShotList.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+plasma.primitives.shots.ShotList
+================================
+
+.. autoclass:: plasma.primitives.shots.ShotList
+    :members:
+    :special-members: __init__, __add__
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/plasma.primitives.shots.get_individual_shot_file.rst b/docs/plasma.primitives.shots.get_individual_shot_file.rst
diff --git a/docs/plasma.utils.evaluation.get_loss.rst b/docs/plasma.utils.evaluation.get_loss.rst
diff --git a/docs/plasma.utils.evaluation.get_loss_from_list.rst b/docs/plasma.utils.evaluation.get_loss_from_list.rst
diff --git a/docs/plasma.utils.performance.PerformanceAnalyzer.rst b/docs/plasma.utils.performance.PerformanceAnalyzer.rst
diff --git a/docs/plasma.utils.processing.append_to_filename.rst b/docs/plasma.utils.processing.append_to_filename.rst
diff --git a/docs/plasma.utils.processing.concatenate_sublists.rst b/docs/plasma.utils.processing.concatenate_sublists.rst
diff --git a/docs/plasma.utils.processing.cut_and_resample_signal.rst b/docs/plasma.utils.processing.cut_and_resample_signal.rst
diff --git a/docs/plasma.utils.processing.cut_signal.rst b/docs/plasma.utils.processing.cut_signal.rst
diff --git a/docs/plasma.utils.processing.get_individual_shot_file.rst b/docs/plasma.utils.processing.get_individual_shot_file.rst
diff --git a/docs/plasma.utils.processing.get_signal_slices.rst b/docs/plasma.utils.processing.get_signal_slices.rst
diff --git a/docs/plasma.utils.processing.resample_signal.rst b/docs/plasma.utils.processing.resample_signal.rst
diff --git a/docs/plasma.utils.processing.train_test_split.rst b/docs/plasma.utils.processing.train_test_split.rst
diff --git a/docs/plasma.utils.processing.train_test_split_all.rst b/docs/plasma.utils.processing.train_test_split_all.rst
diff --git a/docs/plasma.utils.processing.train_test_split_robust.rst b/docs/plasma.utils.processing.train_test_split_robust.rst
