Skip to content

Commit

Permalink
Writing one single docstring for fit_predict() in the base class
Browse files Browse the repository at this point in the history
  • Loading branch information
dmnapolitano committed Jan 30, 2024
1 parent f2d0578 commit d62680b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/elexsolver/TransitionSolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ def __init__(self):
self._transitions = None

def fit_predict(self, X: np.ndarray, Y: np.ndarray, weights: np.ndarray | None = None):
"""
After this method finishes, transitions will be available in the `transitions` class member.
Parameters
----------
`X` : np.ndarray matrix or pandas.DataFrame of int
Must have the same number of rows as `Y` but can have any number of columns greater than the number of rows.
`Y` : np.ndarray matrix or pandas.DataFrame of int
Must have the same number of rows as `X` but can have any number of columns greater than the number of rows.
`weights` : list, np.ndarray, or pandas.Series of int, optional
Must have the same length (number of rows) as both `X` and `Y`.
Returns
-------
np.ndarray matrix of float of shape (number of columns in `X`) x (number of columns in `Y`).
Each float represents the percent of how much of row x is part of column y.
"""
raise NotImplementedError

def get_prediction_interval(self, pi: float):
Expand Down

0 comments on commit d62680b

Please sign in to comment.