From 28823f42884d48050e1a0a62a14b09005492051d Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 5 Mar 2021 13:05:00 +0000 Subject: [PATCH] misc documentation updates --- .meta/.readme.rst | 11 +++++++---- README.rst | 11 +++++++---- benchmarks/README.md | 2 +- tqdm/dask.py | 10 +++++++--- tqdm/gui.py | 6 +----- tqdm/keras.py | 4 ++-- tqdm/rich.py | 6 +----- 7 files changed, 26 insertions(+), 24 deletions(-) diff --git a/.meta/.readme.rst b/.meta/.readme.rst index 4b607bec..d231ffb6 100644 --- a/.meta/.readme.rst +++ b/.meta/.readme.rst @@ -140,7 +140,7 @@ Changelog The list of all changes is available either on GitHub's Releases: |GitHub-Status|, on the `wiki `__, or on the -`website `__. +`website `__. Usage @@ -460,7 +460,10 @@ Submodules """`rich.progress` version.""" class tqdm.keras.TqdmCallback(keras.callbacks.Callback): - """`keras` callback for epoch and batch progress.""" + """Keras callback for epoch and batch progress.""" + + class tqdm.dask.TqdmCallback(dask.callbacks.Callback): + """Dask callback for task progress.""" ``contrib`` @@ -470,8 +473,8 @@ The ``tqdm.contrib`` package also contains experimental modules: - ``tqdm.contrib.itertools``: Thin wrappers around ``itertools`` - ``tqdm.contrib.concurrent``: Thin wrappers around ``concurrent.futures`` -- ``tqdm.contrib.discord``: Posts to `Discord `__ bots -- ``tqdm.contrib.telegram``: Posts to `Telegram `__ bots +- ``tqdm.contrib.discord``: Posts to `Discord `__ bots +- ``tqdm.contrib.telegram``: Posts to `Telegram `__ bots - ``tqdm.contrib.bells``: Automagically enables all optional features * ``auto``, ``pandas``, ``discord``, ``telegram`` diff --git a/README.rst b/README.rst index b80c2d63..97674698 100644 --- a/README.rst +++ b/README.rst @@ -140,7 +140,7 @@ Changelog The list of all changes is available either on GitHub's Releases: |GitHub-Status|, on the `wiki `__, or on the -`website `__. +`website `__. Usage @@ -679,7 +679,10 @@ Submodules """`rich.progress` version.""" class tqdm.keras.TqdmCallback(keras.callbacks.Callback): - """`keras` callback for epoch and batch progress.""" + """Keras callback for epoch and batch progress.""" + + class tqdm.dask.TqdmCallback(dask.callbacks.Callback): + """Dask callback for task progress.""" ``contrib`` @@ -689,8 +692,8 @@ The ``tqdm.contrib`` package also contains experimental modules: - ``tqdm.contrib.itertools``: Thin wrappers around ``itertools`` - ``tqdm.contrib.concurrent``: Thin wrappers around ``concurrent.futures`` -- ``tqdm.contrib.discord``: Posts to `Discord `__ bots -- ``tqdm.contrib.telegram``: Posts to `Telegram `__ bots +- ``tqdm.contrib.discord``: Posts to `Discord `__ bots +- ``tqdm.contrib.telegram``: Posts to `Telegram `__ bots - ``tqdm.contrib.bells``: Automagically enables all optional features * ``auto``, ``pandas``, ``discord``, ``telegram`` diff --git a/benchmarks/README.md b/benchmarks/README.md index a4e2e528..235cb319 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -11,7 +11,7 @@ These benchmarks serve two purposes: - [`progressbar2`](https://pypi.org/project/progressbar2) - [`alive-progress`](https://pypi.org/project/alive-progress) -Performance graphs are available at +Performance graphs are available at ## Running diff --git a/tqdm/dask.py b/tqdm/dask.py index f07d1b9b..730a5e64 100644 --- a/tqdm/dask.py +++ b/tqdm/dask.py @@ -1,13 +1,17 @@ from __future__ import absolute_import -from .auto import tqdm as tqdm_auto + from functools import partial + from dask.callbacks import Callback + +from .auto import tqdm as tqdm_auto + __author__ = {"github.com/": ["casperdcl"]} __all__ = ['TqdmCallback'] class TqdmCallback(Callback): - """`dask` callback for task progress""" + """Dask callback for task progress.""" def __init__(self, start=None, pretask=None, tqdm_class=tqdm_auto, **tqdm_kwargs): """ @@ -34,7 +38,7 @@ class TqdmCallback(Callback): self.pbar.close() def display(self): - """displays in the current cell in Notebooks""" + """Displays in the current cell in Notebooks.""" container = getattr(self.bar, 'container', None) if container is None: return diff --git a/tqdm/gui.py b/tqdm/gui.py index 1daab1ef..4612701d 100644 --- a/tqdm/gui.py +++ b/tqdm/gui.py @@ -24,12 +24,8 @@ __all__ = ['tqdm_gui', 'tgrange', 'tqdm', 'trange'] class tqdm_gui(std_tqdm): # pragma: no cover - """ - Experimental Matplotlib GUI version of tqdm! - """ - + """Experimental Matplotlib GUI version of tqdm!""" # TODO: @classmethod: write() on GUI? - def __init__(self, *args, **kwargs): from collections import deque diff --git a/tqdm/keras.py b/tqdm/keras.py index 8587bb09..4a808f15 100644 --- a/tqdm/keras.py +++ b/tqdm/keras.py @@ -17,7 +17,7 @@ __all__ = ['TqdmCallback'] class TqdmCallback(keras.callbacks.Callback): - """`keras` callback for epoch and batch progress""" + """Keras callback for epoch and batch progress.""" @staticmethod def bar2callback(bar, pop=None, delta=(lambda logs: 1)): def callback(_, logs=None): @@ -98,7 +98,7 @@ class TqdmCallback(keras.callbacks.Callback): self.epoch_bar.close() def display(self): - """displays in the current cell in Notebooks""" + """Displays in the current cell in Notebooks.""" container = getattr(self.epoch_bar, 'container', None) if container is None: return diff --git a/tqdm/rich.py b/tqdm/rich.py index 944691b9..0ad6545a 100644 --- a/tqdm/rich.py +++ b/tqdm/rich.py @@ -74,12 +74,8 @@ class RateColumn(ProgressColumn): class tqdm_rich(std_tqdm): # pragma: no cover - """ - Experimental rich.progress GUI version of tqdm! - """ - + """Experimental rich.progress GUI version of tqdm!""" # TODO: @classmethod: write()? - def __init__(self, *args, **kwargs): """ This class accepts the following parameters *in addition* to