-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merge additional pydocstyle error fixes into development docs #1208
Merged
Merged
Changes from all commits
Commits
Show all changes
51 commits
Select commit
Hold shift + click to select a range
c4cf883
Fix _fh.py docstrings
RNKuhns 0c1148c
Remove __init_ from class_with_call doc template
RNKuhns 88bc778
Update api reference files .rst files
RNKuhns 1a5a084
Tweak docstrings
RNKuhns fcb049d
more pydocstyle docs fixes
RNKuhns 1bc1371
Merge branch 'update_docs' into fix_docs
RNKuhns d4b92a0
Update doc python object templates
RNKuhns caf6ff4
Switch to numpydoc extension and pydata theme
RNKuhns b139b08
Merge branch 'fix_docs' of https://github.com/RNKuhns/sktime into fix…
RNKuhns 016aeb6
Update doc requirements
RNKuhns 3b8e203
Remove autosummary
RNKuhns 8cc66c0
Change docstring example to examples
RNKuhns 8cb6cbf
Classification doc tweaks
RNKuhns f8f17a2
Series transformer docstring tweaks
RNKuhns d40217b
Change State docstring heading moved to notes
RNKuhns aa7a74a
Annotation docstring tweaks
RNKuhns a98e8c3
Tweak dataset docstrings
RNKuhns cf2b3e3
Additional docstring tweak
RNKuhns ab5f5c8
add twitter and discord icons
mloning 3b27bb5
add edit-this-page button
mloning 9f4f587
remove estimator from init
mloning 61eedf4
More docstring tweaks based on numpydoc warnings
RNKuhns bbcff93
Merge branch 'fix_docs' of https://github.com/RNKuhns/sktime into fix…
RNKuhns 795f53b
More numpydoc warning fixes
RNKuhns 4dbc909
Add validation checks when building docs with numpydoc
RNKuhns bb9e141
Restructuring content
mloning b2163b8
remove estimator table since it's auto-generated
mloning dc4352a
Merge branch 'fix_docs' of https://github.com/RNKuhns/sktime into fix…
mloning 12ea108
Add getting started doc page
RNKuhns 979deac
Fix annotation pydocstyle errors
RNKuhns 6ffb33f
Add module docstring in _meta.py
RNKuhns ce4b176
Fix pydocstyle errors in _rise.py
RNKuhns eb1f754
Fix pydocstyle errors in datasets
RNKuhns e82cca6
Fix pydocstyle error in regression/__init__.py
RNKuhns ef5caef
Fix pydocstyle errors in regression module
RNKuhns 1777f7d
Fix pydocstyle errors in registry
RNKuhns 6d69875
Fix pydocstyle errors in performance_metrics
RNKuhns efe6e10
Fix series_as_features ensemble pydocstyle errors
RNKuhns 37cff90
Fix pydocstyle errors in forecasting base
RNKuhns 88abca0
Tweak language in performance_metrics docs
RNKuhns dd908fb
Merge branch 'fix_docs' into forecasting_docstrings
RNKuhns ab3af32
Merge pull request #4 from RNKuhns/forecasting_docstrings
RNKuhns b0732d2
More pydocstyle error fixes in forecasting module
RNKuhns cee41cd
Still more pydocstyle error fixes in forecasting
RNKuhns e0272fa
Fix pydocstyle errors in forecasting model_evaluation
RNKuhns 7810a09
Forecasting adapter pydocstyle error fixes
RNKuhns 5fd7f69
Merge branch with pydocstyle error fixes
RNKuhns 3581d14
Streamline getting started and fix code blocks
RNKuhns 253a8d9
Add autodoc option to order members by source code
RNKuhns 11c0cd4
Update quickstart
RNKuhns cca38a9
Merge branch 'docs-dev' into docs-dev
mloning File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
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,14 @@ | ||
.. _get_involved: | ||
|
||
Get involved | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
contributing | ||
developer_guide | ||
mentoring | ||
roadmap | ||
code_of_conduct | ||
governance |
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
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
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,16 @@ | ||
.. _user_documentation: | ||
|
||
User Documentation | ||
================== | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
installation | ||
tutorials | ||
user_guide | ||
estimator_overview | ||
api_reference | ||
changelog | ||
roadmap | ||
related_software |
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,2 @@ | ||
# -*- coding: utf-8 -*- | ||
"""Implements time series annotation.""" |
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,4 +1,8 @@ | ||
#!/usr/bin/env python3 -u | ||
# -*- coding: utf-8 -*- | ||
# copyright: sktime developers, BSD-3-Clause License (see LICENSE file) | ||
"""Implements adapters for time series annotation.""" | ||
|
||
__all__ = ["PyODAnnotator"] | ||
|
||
from sktime.annotation.adapters._pyod import PyODAnnotator |
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
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,4 +1,8 @@ | ||
#!/usr/bin/env python3 -u | ||
# -*- coding: utf-8 -*- | ||
# copyright: sktime developers, BSD-3-Clause License (see LICENSE file) | ||
"""Implements base classes for annotation in sktime.""" | ||
|
||
__all__ = ["BaseSeriesAnnotator"] | ||
|
||
from sktime.annotation.base._base import BaseSeriesAnnotator |
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
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
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
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
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,4 +1,5 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
""" | ||
List of datasets available from the timeseriesclassification.com archive. | ||
|
||
|
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is nice! so we should make sure
fit
,predict
,transform
andupdate
are at the top in the code, right?