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.

Sign up for GitHub

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

Jump to bottom

fix docstring mistakes #82

Merged
merged 1 commit into from
May 31, 2022
Merged

fix docstring mistakes #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 7 additions & 10 deletions pyadjoint/tape.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,9 +356,11 @@ def visualise(self, output="log", launch_tensorboard=False, open_in_browser=Fals

Args:
output (str): Directory where event files for TensorBoard is
stored. Default log. launch_tensorboard (bool): Launch TensorBoard
in the background. Default False. open_in_browser (bool): Opens
http://localhost:6006/ in a web browser. Default False.
stored. Default log.
launch_tensorboard (bool): Launch TensorBoard in the background.
Default False.
open_in_browser (bool): Opens http://localhost:6006/ in a web
browser. Default False.
"""
if output.endswith(".dot"):
return self.visualise_dot(output)
Expand Down Expand Up @@ -435,13 +437,13 @@ def visualise_pdf(self, filename):
def progress_bar(self):
"""Specify a progress bar class to print during tape evaluation.

Setting this attribute to a subclass of :class:`progress.Bar` will
Setting this attribute to a subclass of :class:`progress.bar.Bar` will
cause every evaluation of a reduced functional, adjoint, TLM or Hessian
to print a progress bar.

For example, the following code::

from progress import FillingSquaresBar
from progress.bar import FillingSquaresBar
tape = get_working_tape()
tape.progress_bar = FillingSquaresBar

Expand All @@ -454,11 +456,6 @@ def progress_bar(self):
For information on available progress bar styles and their
configuration, see the `progress package documentation
<https://pypi.org/project/progress/>`_.

.. note::

When running in parallel, you probably only want to set a progress
bar on one MPI rank.
"""
return self._bar

Expand Down