This repository has been archived by the owner on Dec 20, 2024. It is now read-only.
DOC: Miscellaneous gpr module documentation fixes
#259
Conversation
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
Fix typos in GPR model documentation.
Expand GP acronym when introduced for the first time in GPR model module.
Prefer impersonal style in `EddyMotionGPR` hyperparameter optimization comment.
Do not introduce unnecessary line breaks within paragraph. Take advantage of the commit to use literal highlighting syntax for the `alpha` parameter for the sake of consistency.
Use literal highlighting syntax for the `a` parameter in `gpr` module `ExponentialKriging` initialization method.
Use `obj` Sphinx role to reference `NumPy` arrays consistently in `gpr` module docstrings.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #259 +/- ##
=======================================
Coverage 66.24% 66.24%
=======================================
Files 19 19
Lines 942 942
Branches 119 119
=======================================
Hits 624 624
Misses 274 274
Partials 44 44 ☔ View full report in Codecov by Sentry. |
oesteban
approved these changes
Dec 19, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
EddyMotionGPRhpm optimization commentaparameterNumPyarrays consistently