-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC update and split whats new (#31)
- Loading branch information
Showing
2 changed files
with
71 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,22 @@ | ||
.. currentmodule:: skcycling | ||
|
||
Release History | ||
=============== | ||
Release history | ||
=============== | ||
|
||
.. _changes_0_1: | ||
Release notes for current and recent releases are detailed on this page, with | ||
:ref:`previous releases <previous_releases_whats_new>` linked below. | ||
|
||
.. include:: whats_new/v0.1.rst | ||
|
||
.. _previous_releases_whats_new: | ||
|
||
Previous Releases | ||
================= | ||
|
||
`scikit-cycling` is to young and we do not have old releases. | ||
.. | ||
Version 0.1 | ||
=========== | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
Changelog | ||
--------- | ||
Version 0.1 <whats_new/v0.1.rst> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
.. currentmodule:: skcycling | ||
|
||
.. _change_0_1: | ||
|
||
Version 0.1 | ||
=========== | ||
|
||
Changelog | ||
--------- | ||
|
||
New features | ||
............ | ||
|
||
Base | ||
|
||
- :class:`Rider` allows to store and easily manipulate power data of a | ||
cyclist. By :user:`Guillaume Lemaitre <glemaitre>`. | ||
|
||
Datasets | ||
|
||
- :func:`datasets.load_fit` and :func:`datasets.load_rider` provides datasets | ||
for `.fit` files and internal rider files, respectively. By :user:`Guillaume | ||
Lemaitre <glemaitre>`. | ||
|
||
Extraction | ||
|
||
- :func:`extraction.activity_power_profile` allows to extract the power-profile | ||
of an activity. By :user:`Guillaume Lemaitre <glemaitre>`. | ||
|
||
- :func:`extraction.acceleration`, :func:`extraction.gradient_elevation`, and | ||
:func:`extraction.gradient_heart_rate` allows to extract the gradient of the | ||
speed, elevation, and the heart-rate. By :user:`Guillaume Lemaitre | ||
<glemaitre>`. | ||
|
||
- :func:`extraction.gradient_activity` allows to compute the gradient for all | ||
available data for a given period. By :user:`Guillaume Lemaitre <glemaitre>`. | ||
|
||
Input/Output | ||
|
||
- :func:`bikeread` implement a common interface to read bike files. By | ||
:user:`Guillaume Lemaitre <glemaitre>`. | ||
|
||
Metrics | ||
|
||
- :func:`metrics.std_dev_squared_error` computes the standard deviation of the | ||
squared error when dealing with regression. By :user:`Guillaume Lemaitre | ||
<glemaitre>`. | ||
|
||
- :func:`metrics.aerobic_meta_model` computes the aerobic model (MPA | ||
mainly). By :user:`Guillaume Lemaitre <glemaitre>`. | ||
|
||
Model | ||
|
||
- :func:`strava_power_model` implements the method used in Strava for the | ||
prediction of power from GPS data. By :user:`Guillaume Lemaitre <glemaitre>`. |