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

Docs: Fix issues callback docs #867

Merged
merged 3 commits into from
Jul 5, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Reviewer feedback: use code blocks
  • Loading branch information
BenjaminBossan committed Jul 5, 2022
commit 82c145f27ac5c2699f43b3b9d40f9d167522793e
9 changes: 7 additions & 2 deletions skorch/callbacks/logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -756,7 +756,9 @@ class SacredLogger(Callback):

To use this logger, you first have to install Sacred:

``$ python -m pip install sacred``
.. code-block:: bash

python -m pip install sacred

You might also install pymongo to use a mongodb backend. See the `upstream
documentation <https://github.com/IDSIA/sacred#installing>`_ for more
Expand Down Expand Up @@ -793,7 +795,10 @@ class SacredLogger(Callback):
... net.fit(X, y)

Then call this from the command line, e.g. like this:
``python sacred-script.py with max_epochs=15``

.. code-block:: bash

python sacred-script.py with max_epochs=15

You can also change other options on the command line and optionally
specify a backend.
Expand Down