-
Notifications
You must be signed in to change notification settings - Fork 382
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
Documentation updates #242
Conversation
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.
Apart from a typo, this looks good. I will probably merge on Monday.
docs/user/neuralnet.rst
Outdated
:func:`~skorch.net.NeuralNet.forward_iter` method to generate outputs | ||
from the ``module``, or directly call ``net.module_(X)``. | ||
If the :func:`~torch.nn.Module.forward`\-output can not be meaningfuly | ||
casted to a :class:`numpy.ndarray`, or if you need access to all |
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.
casted cast
Frankly, this is a mistake, not a typo :) Will update this PR on Monday. |
Done. |
docs/user/neuralnet.rst
Outdated
converted to a ``numpy`` array. Alternatively, consider using the | ||
:func:`~skorch.net.NeuralNet.forward_iter` method to generate outputs | ||
from the ``module``, or directly call ``net.module_(X)``. | ||
If the :func:`~torch.nn.Module.forward`\-output can not be meaningfuly |
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.
Sorry, I noticed the typo in "meaningfuly" just now. But I wonder whether this word is needed here at all. If the passage just reads "... cannot be cast to ...", the meaning should be clear.
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.
Agree, fixed.
Great, thanks. |
This PR contains a bunch of minor documentation fixes, see individual commit messages. Closes #238.