Fixes to HMM docstrings #2525
Merged
Fixes to HMM docstrings #2525
Conversation
This file contains hidden or 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
|
looks good. thanks +1 |
| ---------- | ||
| obs : list | ||
| List of array-like observation sequences, each of which | ||
| has shape (n, n_features) |
There was a problem hiding this comment.
I would rather say: "has shape (n_i, n_features) where n_i is the length of the i_th observation."
|
Apart from the nitpick on the shape doc, +1 for merging as well. |
|
@ogrisel: done. I also standardized docstrings for the functions that take a single observation sequence. |
|
This looks good. Thank you; Merging. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As pointed out in #1817, many of the
paramsandinit_paramsdocstrings were specific to the correct subclass, and some options were not documented. Also, thefit()docstring of BaseHMM that was being inherited in some of the subclass had information specific toGaussianHMM.