DOC: Added examples, overview and docummentation for the session

dataframe.
corriporai · Jul 15, 2021 · 00552da · 00552da
1 parent 1f03433
commit 00552da
Show file tree

Hide file tree

Showing 167 changed files with 600,070 additions and 28 deletions.
diff --git a/README.rst b/README.rst
diff --git a/docs/source/_version.txt b/docs/source/_version.txt
@@ -1 +1 @@
-Version: **0.4.0 (+14, 58212c0)** Date: **May 28, 2021**
+Version: **0.4.0 (+26, 1f03433)** Date: **July 13, 2021**
diff --git a/docs/source/reference/acessors.rst b/docs/source/reference/acessors.rst
@@ -27,4 +27,22 @@ Metrics
    metrics.MetricsAcessor.gradient
    metrics.MetricsAcessor.pace
    metrics.MetricsAcessor.heart_zone
-   metrics.MetricsAcessor.time_in_zone
+   metrics.MetricsAcessor.time_in_zone
+
+
+Session
+-------
+
+.. autosummary::
+   :toctree: api/
+
+   session._SessionAcessor
+   session._SessionAcessor.summarize
+   session._SessionAcessor.count
+   session._SessionAcessor.distance
+   session._SessionAcessor.speed
+   session._SessionAcessor.vertical_speed
+   session._SessionAcessor.gradient
+   session._SessionAcessor.pace
+   session._SessionAcessor.heart_zone
+   session._SessionAcessor.only_moving
diff --git a/docs/source/reference/api/runpandas.types.Activity.rst b/docs/source/reference/api/runpandas.types.Activity.rst
@@ -170,6 +170,7 @@ runpandas.types.Activity
       ~Activity.sub
       ~Activity.subtract
       ~Activity.sum
+      ~Activity.summary
       ~Activity.swapaxes
       ~Activity.swaplevel
       ~Activity.tail

diff --git a/...source/reference/api/runpandas.types.acessors.session._SessionAcessor.count.rst b/...source/reference/api/runpandas.types.acessors.session._SessionAcessor.count.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.count
+=======================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.count
diff --git a/...rce/reference/api/runpandas.types.acessors.session._SessionAcessor.distance.rst b/...rce/reference/api/runpandas.types.acessors.session._SessionAcessor.distance.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.distance
+==========================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.distance
diff --git a/...rce/reference/api/runpandas.types.acessors.session._SessionAcessor.gradient.rst b/...rce/reference/api/runpandas.types.acessors.session._SessionAcessor.gradient.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.gradient
+==========================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.gradient
diff --git a/...e/reference/api/runpandas.types.acessors.session._SessionAcessor.heart_zone.rst b/...e/reference/api/runpandas.types.acessors.session._SessionAcessor.heart_zone.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.heart\_zone
+=============================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.heart_zone
diff --git a/.../reference/api/runpandas.types.acessors.session._SessionAcessor.only_moving.rst b/.../reference/api/runpandas.types.acessors.session._SessionAcessor.only_moving.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.only\_moving
+==============================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.only_moving
diff --git a/.../source/reference/api/runpandas.types.acessors.session._SessionAcessor.pace.rst b/.../source/reference/api/runpandas.types.acessors.session._SessionAcessor.pace.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.pace
+======================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.pace
diff --git a/docs/source/reference/api/runpandas.types.acessors.session._SessionAcessor.rst b/docs/source/reference/api/runpandas.types.acessors.session._SessionAcessor.rst
@@ -0,0 +1,31 @@
+runpandas.types.acessors.session.\_SessionAcessor
+=================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. autoclass:: _SessionAcessor
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~_SessionAcessor.__init__
+      ~_SessionAcessor.count
+      ~_SessionAcessor.distance
+      ~_SessionAcessor.gradient
+      ~_SessionAcessor.heart_zone
+      ~_SessionAcessor.only_moving
+      ~_SessionAcessor.pace
+      ~_SessionAcessor.speed
+      ~_SessionAcessor.summarize
+      ~_SessionAcessor.vertical_speed
+
+
+
+
+
+
diff --git a/...source/reference/api/runpandas.types.acessors.session._SessionAcessor.speed.rst b/...source/reference/api/runpandas.types.acessors.session._SessionAcessor.speed.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.speed
+=======================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.speed
diff --git a/...ce/reference/api/runpandas.types.acessors.session._SessionAcessor.summarize.rst b/...ce/reference/api/runpandas.types.acessors.session._SessionAcessor.summarize.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.summarize
+===========================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.summarize
diff --git a/...ference/api/runpandas.types.acessors.session._SessionAcessor.vertical_speed.rst b/...ference/api/runpandas.types.acessors.session._SessionAcessor.vertical_speed.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.session.\_SessionAcessor.vertical\_speed
+=================================================================
+
+.. currentmodule:: runpandas.types.acessors.session
+
+.. automethod:: _SessionAcessor.vertical_speed
diff --git a/docs/source/reference/api/runpandas.types.summary.activity_summary.rst b/docs/source/reference/api/runpandas.types.summary.activity_summary.rst
@@ -0,0 +1,6 @@
+runpandas.types.summary.activity\_summary
+=========================================
+
+.. currentmodule:: runpandas.types.summary
+
+.. autofunction:: activity_summary
diff --git a/docs/source/reference/api/runpandas.types.summary.session_summary.rst b/docs/source/reference/api/runpandas.types.summary.session_summary.rst
@@ -0,0 +1,6 @@
+runpandas.types.summary.session\_summary
+========================================
+
+.. currentmodule:: runpandas.types.summary
+
+.. autofunction:: session_summary
diff --git a/docs/source/reference/reference.rst b/docs/source/reference/reference.rst
@@ -12,6 +12,7 @@ Reference
   MeasureSeries <columns>
   Acessors <acessors>
   Input/output <io>
+  Summary <summary>
   Datasets <datasets>
   Tools <tools>
   Testing <testing>
diff --git a/docs/source/reference/summary.rst b/docs/source/reference/summary.rst
@@ -0,0 +1,15 @@
+.. _summary:
+
+=======
+Summary
+=======
+
+Helper module for evaluation and display of the summary of training sessions.
+
+.. currentmodule:: runpandas.types.summary
+
+.. autosummary::
+   :toctree: api/
+
+   session_summary
+   activity_summary