Skip to content
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

Update Docstrings in all classes related to RandomVariables #213

Merged

Conversation

JonathanWenger
Copy link
Contributor

@JonathanWenger JonathanWenger commented Sep 10, 2020

This PR updates and adds missing docstrings to the recently refactored classes associated with RandomVariable.

Docstrings

Tutorials and Quickstart Guide:

  • Update the quickstart guide and notebooks explaining the use of random variables

Developer Guides:

  • [ ] describe the steps to add a new RandomVariable subclass, including how to define new arithmetic operations

Other:

This PR closes #199.

Note: You can view the built documentation by going to the "Details" page of the docs/readthedocs.org:probnum check, which builds a version of the documentation corresponding to this PR.

@JonathanWenger JonathanWenger added documentation Improvements or additions to documentation randvars Issues related to random variables labels Sep 10, 2020
@JonathanWenger JonathanWenger self-assigned this Sep 10, 2020
@codecov
Copy link

codecov bot commented Sep 10, 2020

Codecov Report

Merging #213 (38f12ba) into master (426199a) will increase coverage by 0.48%.
The diff coverage is 86.48%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #213      +/-   ##
==========================================
+ Coverage   74.40%   74.88%   +0.48%     
==========================================
  Files          60       60              
  Lines        3169     3158      -11     
  Branches      414      410       -4     
==========================================
+ Hits         2358     2365       +7     
+ Misses        647      624      -23     
- Partials      164      169       +5     
Impacted Files Coverage Δ
src/probnum/__init__.py 77.77% <ø> (ø)
src/probnum/diffeq/__init__.py 100.00% <ø> (ø)
src/probnum/diffeq/ode/ivp.py 98.57% <ø> (ø)
src/probnum/diffeq/odefiltsmooth/ivp2filter.py 81.14% <0.00%> (ø)
src/probnum/diffeq/odefiltsmooth/odefiltsmooth.py 68.68% <ø> (ø)
src/probnum/diffeq/odesolution.py 97.14% <ø> (ø)
src/probnum/filtsmooth/__init__.py 100.00% <ø> (ø)
src/probnum/linalg/__init__.py 100.00% <ø> (ø)
src/probnum/linalg/linearsolvers/linearsolvers.py 47.61% <ø> (ø)
src/probnum/linalg/linearsolvers/matrixbased.py 58.35% <ø> (ø)
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 426199a...38f12ba. Read the comment docs.

@JonathanWenger JonathanWenger marked this pull request as ready for review November 3, 2020 18:47
Copy link
Collaborator

@marvinpfoertner marvinpfoertner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a comment every time something didn't read smoothly, so my comments are relatively noisy. Not everything needs fixing.

docs/source/public_api/diffeq.rst Show resolved Hide resolved
docs/source/public_api/linops.rst Outdated Show resolved Hide resolved
docs/source/public_api/random_variables.rst Show resolved Hide resolved
docs/source/public_api/linops.rst Outdated Show resolved Hide resolved
src/probnum/__init__.py Show resolved Hide resolved
src/probnum/random_variables/_random_variable.py Outdated Show resolved Hide resolved
src/probnum/random_variables/_random_variable.py Outdated Show resolved Hide resolved
src/probnum/random_variables/_random_variable.py Outdated Show resolved Hide resolved
@JonathanWenger JonathanWenger merged commit 65793ec into probabilistic-numerics:master Nov 10, 2020
@JonathanWenger JonathanWenger deleted the docstring-updates branch November 10, 2020 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation randvars Issues related to random variables
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation of changes in RandomVariable Write a warning into RandomVariable about order of operations
2 participants