Skip to content

Commit

Permalink
Fix remaining sphinx-incompatible docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
briandesilva committed Feb 7, 2020
1 parent 852c172 commit 7a5a7ba
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
3 changes: 2 additions & 1 deletion pysindy/feature_library/feature_library.py
Expand Up @@ -11,7 +11,8 @@ class BaseFeatureLibrary(TransformerMixin):
"""
Base class for feature libraries.
Forces subclasses to implement fit and transform functions.
Forces subclasses to implement `fit`, `transform`,
and `get_feature_names` functions.
"""

def __init__(self, **kwargs):
Expand Down
14 changes: 7 additions & 7 deletions pysindy/pysindy.py
Expand Up @@ -127,8 +127,8 @@ def fit(self, x, t=1, x_dot=None, multiple_trajectories=False):
trajectory.
Default value is a timestep of 1 between samples.
x_dot: array-like or list of array-like, shape (n_samples,
n_input_features), optional (default None)
x_dot: array-like or list of array-like, shape (n_samples, n_input_features), \
optional (default None)
Optional pre-computed derivatives of the training data. If not
provided, the time derivatives of the training data will be
computed using the specified differentiation method. If x_dot is
Expand Down Expand Up @@ -285,8 +285,8 @@ def score(
used to compute the time derivatives of the samples if x_dot is not
provided.
x_dot: array-like or list of array-like, shape
(n_samples, n_input_features), optional
x_dot: array-like or list of array-like, shape (n_samples, n_input_features), \
optional
Optional pre-computed derivatives of the samples. If provided,
these values will be used to compute the score. If not provided,
the time derivatives of the training data will be computed using
Expand All @@ -306,7 +306,7 @@ def score(
Returns
-------
score: float
Metric function value for the model prediction of x_dot
Metric function value for the model prediction of x_dot.
"""
if multiple_trajectories:
x, x_dot = self.process_multiple_trajectories(
Expand Down Expand Up @@ -382,7 +382,7 @@ def process_multiple_trajectories(self, x, t, x_dot, return_array=True):

def differentiate(self, x, t=1, multiple_trajectories=False):
"""
Apply the model's differentiation method to data
Apply the model's differentiation method to data.
Parameters
----------
Expand Down Expand Up @@ -445,7 +445,7 @@ def simulate(self, x0, t, integrator=odeint, stop_condition=None, **integrator_k
Parameters
----------
x0: numpy array, size [n_features]
Initial condition from which to simulate
Initial condition from which to simulate.
t: int or numpy array of size [n_samples]
If the model is in continuous time, t must be an array of time
Expand Down

0 comments on commit 7a5a7ba

Please sign in to comment.