Docs: Fix issues callback docs #867
Merged
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
- Added/removed some blank lines for consistency - Some entries like 'event_' were interpreted as links, so I added code markers around them. - Added usage example to TensorBoard docstring - Fixed a copy paste error in WandbLogger - Some links were not parsed correctly, so I used different syntax - Fixed issue in code example of SacredLogger What I would like to know: Is it possible to have blank lines inside example code blocks without starting a completely new block? Some examples are now very cramped and I would like to add some blank lines, but don't know how.
BenjaminBossan
changed the title
thomasjpfan
reviewed
Jul 4, 2022
skorch/callbacks/logging.py
Outdated
| @@ -747,32 +756,30 @@ class SacredLogger(Callback): | |||
|
|
|||
| To use this logger, you first have to install Sacred: | |||
|
|
|||
| $ python -m pip install sacred | |||
| ``$ python -m pip install sacred`` | |||
There was a problem hiding this comment.
I think this works for Sphinx?
Suggested change
| ``$ python -m pip install sacred`` | |
| .. code-block:: | |
| $ python -m pip install sacred |
There was a problem hiding this comment.
I used code blocks for the 2 shell commands in this docstring.
| >>> import numpy as np | ||
| >>> from sacred import Experiment | ||
| >>> from sklearn.datasets import make_classification | ||
| >>> from skorch.callbacks.logging import SacredLogger | ||
| >>> from skorch.callbacks.scoring import EpochScoring | ||
| >>> from skorch import NeuralNetClassifier | ||
| >>> from skorch.toy import make_classifier | ||
|
|
There was a problem hiding this comment.
One way to split this up is to add a comment describing the code.
XREF: https://numpydoc.readthedocs.io/en/latest/format.html#examples
There was a problem hiding this comment.
Yes, but I wanted to avoid that. My goal would be to just have a block of code with some blank lines:
from skorch import NeuralNetClassifier
from skorch.toy import make_classifier
ex = Experiment()
@ex.config
def my_config():
max_epochs = 20
lr = 0.01
X, y = make_classification()Adding comments seems unnecessary to me in this case.
There was a problem hiding this comment.
Ah I see. I do not think there is a great way to do this.
thomasjpfan
approved these changes
Jul 5, 2022
| >>> import numpy as np | ||
| >>> from sacred import Experiment | ||
| >>> from sklearn.datasets import make_classification | ||
| >>> from skorch.callbacks.logging import SacredLogger | ||
| >>> from skorch.callbacks.scoring import EpochScoring | ||
| >>> from skorch import NeuralNetClassifier | ||
| >>> from skorch.toy import make_classifier | ||
|
|
There was a problem hiding this comment.
Ah I see. I do not think there is a great way to do this.
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.
I fixed a couple of minor issues I found in the docs
markers around them.
TensorBoarddocstringWandbLoggerSacredLoggerAdditionally, I removed an outdated comment in
probabilistic.pydocstring.What I would like to know: Is it possible to have blank lines inside
example code blocks without starting a completely new block? Some
examples are now very cramped and I would like to add some blank lines,
but don't know how.
Also, it looks like in the official docs, the API docs for
probabilistic.pyare empty:https://skorch.readthedocs.io/en/latest/probabilistic.html
I cannot reproduce this error locally :(