Fix HandlersTimeProfiler example rendering #1428
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
|
I've tried to fit 100% zoom, I hope it is not too small) |
vfdev-5
reviewed
Oct 31, 2020
| @@ -143,3 +143,7 @@ article.pytorch-article table.longtable.docutils.align-default tbody td p { | |||
| margin-block-start: 0.1em; | |||
| margin-block-end: 0.1em; | |||
| } | |||
|
|
|||
| article.pytorch-article div#ignite-contrib-handlers.section div#time-profilers.section dl.py.class dd dl.py.method dd div.highlight-text.notranslate div.highlight pre { | |||
| font-size: 62%; | |||
There was a problem hiding this comment.
Maybe, 75% will be enough and not that small :)
There was a problem hiding this comment.
the problem is 62% is the highest acceptable value to fit line, 75 will break the lines
There was a problem hiding this comment.
There is another idea, to trim that example a little, but keep all important information:
------------------------------------- ------------------- -------------- ...
Handler Event Name Total(s)
------------------------------------- ------------------- --------------
run.<locals>.log_training_results EPOCH_COMPLETED 19.43245
run.<locals>.log_validation_results EPOCH_COMPLETED 2.55271
run.<locals>.log_time EPOCH_COMPLETED 0.00049
run.<locals>.log_intermediate_results EPOCH_COMPLETED 0.00106
run.<locals>.log_training_loss ITERATION_COMPLETED 0.059
run.<locals>.log_time COMPLETED not triggered
------------------------------------- ------------------- --------------
Total 22.04571
------------------------------------- ------------------- --------------
Processing took total 11.29543s [min/index: 0.00393s/1875, max/index: 0.00784s/0,
mean: 0.00602s, std: 0.00034s]
Dataflow took total 16.24365s [min/index: 0.00533s/1874, max/index: 0.01129s/937,
mean: 0.00866s, std: 0.00113s]
with such modification we can increase font-size from 62 to 72
There was a problem hiding this comment.
or 69% to fit that ...
|
@vfdev-5 Wait! Look what I've found!! A scrollbar!! |
|
Awesome! Let's add the scrollbar and wont bother with the size 👍 |
|
What do you think if we enable the scrollbar for all sections ? |
|
Are you thinking about enabling it globally for a such code example or just for the |
|
Yes, I was thinking about enabling it globally for all code examples. |
|
Yes, I think it would be great to have a such feature! I am going to try it! |
vfdev-5
added a commit
to vfdev-5/ignite
that referenced
this pull request
Nov 24, 2020
* Update TQDM to > 4.48.0 (pytorch#1339) * Fix tqdm 4.49.0 tests. * update requirements. * Use distutils instead of packaging for getting package version. * Reformat code. * Reformat using black 19.10b0. Co-authored-by: vfdev <vfdev.5@gmail.com> * Activate mypy in ignite.utils (pytorch#1352) * Activate mypy in ignite.utils * Add missing torch package to lint stage * Move mypy check to test stage Co-authored-by: vfdev <vfdev.5@gmail.com> * Exposed EventEnum in docs and added import statement in its examples (pytorch#1345) (pytorch#1353) * Update Shpinx to v3.1. (pytorch#1356) Fixes pytorch#1272 * Update README.md * Update doc of examples for Trains fileserver setup (pytorch#1360) * update doc for trains fileserver setup * replace github issue by documentation Co-authored-by: Desroziers <sylvain.desroziers@ifpen.fr> * Updated commit fix (pytorch#1361) (pytorch#1364) * Updated commit fix * Update code-style.yml Co-authored-by: rex_divakar <rexdivakar@hotmail.com> * added tuple type to mixins.py (pytorch#1365) * added tuple type to mixins.py * allow mypy to pass through base file * fixed linting issues Co-authored-by: vfdev <vfdev.5@gmail.com> * Activate mypy in ignite.distributed (pytorch#1355) * Activate mypy in ignite.distributed * Fix tests & py3.5 inline type hints * Remove typing,overload * Fix multiple typing issues * Fix typing issues * Fix TPU test Co-authored-by: vfdev <vfdev.5@gmail.com> * Improve typing for ignite.handlers module (1343) (pytorch#1349) * Improve typing for ignite.handlers module (1343) * autopep8 fix * Fix typing for py35, remove handlers block from mypy.ini * Add exception to ModelCheckpoint when saving last checkpoint * Add test for ModelCheckpoint with redefined save_handler case * autopep8 fix Co-authored-by: AutoPEP8 <> Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> Co-authored-by: trsvchn <trsvchn@users.noreply.github.com> * [3] [contrib/metrics] setup typing in contrib part of the library (pytorch#1363) * [3] [contrib/metrics] setup typing in contrib part of the library * review changes * Update gpu_info.py Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * [2] [contrib/handlers] setup typing in contrib part of the library (pytorch#1362) * [2] [contrib/handlers] setup typing in contrib part of the library * Fix a typo in tqdm logger * review comments * Update mlflow_logger.py * Update neptune_logger.py * review changes * review changes Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * [1] [contrib/engines] setup typing in contrib part of the library (pytorch#1351) * setup typing for contribute/engine part of the code * revert doc string changes * Update common.py Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * Update PULL_REQUEST_TEMPLATE.md * Disable cross-ref links for type annotations (pytorch#1374) * Added reinit__is_reduced and sync_all_reduce docs in metrics doc (pytorch#1373) * added links to reinit__is_reduced and sync_all_reduce decorators in metrics documentation * updated order in list of metrics * deleted decorators from metric list * Update metrics.rst Co-authored-by: vfdev <vfdev.5@gmail.com> * warning if current device index is lower than current local rank (pytorch#1335) (pytorch#1376) * warning if current device index is lower than current local rank (pytorch#1335) * warning if current device index is lower than current local rank * Updated code and tests * Fixed formatting * Updated code and tests for horovod - fixed failing test * Updated tests Co-authored-by: vfdev-5 <vfdev.5@gmail.com> * Removed debug prints * Fixed failing hvd tests Co-authored-by: Sai Sandeep Mutyala <rageofepicfury@gmail.com> * Github Actions workflow CI for horovod on CPU (pytorch#1377) * Initial commit * Update hvd-tests.yml * Update hvd-tests.yml * Update hvd-tests.yml * trigger GitHub actions * removed examples * trigger GitHub actions * Improve typing of distributed.comp_modules.utils.all_gather (pytorch#1370) * Improve typing of distributed.comp_modules.utils.all_gather * Fix all_gather gloo test * Fix XLA test Co-authored-by: vfdev <vfdev.5@gmail.com> * Removed state.restart method (pytorch#1385) * Activate mypy in ignite.engine (pytorch#1379) * Activate mypy in ignite.engine * Fix missing import * Fix typing issues with nighty build * Fix PR findings Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * add acknowledgment for IFPEN (pytorch#1387) Co-authored-by: Desroziers <sylvain.desroziers@ifpen.fr> * Fix collections DeprecationWarning (pytorch#1388) * Remove deprecated CustomPeriodicEvent from nb example, fix tb OutputHadler (pytorch#1389) * Update checkpoint.py (pytorch#1394) * Add GH Action to build and publish Docker images (pytorch#1390) * ADD GH Action to build and publish Docker images * Configure GH action for Docker build * Fix image_tag fetching * Fix identation for main steps * Add token envs for GH docker action, fix push all tag_image * Switch to horovod 0.20.3 * Push images on push events * Fix if conditional * Toctrees for classes and methods using sphinx autosummary (pytorch#1393) * Implement autosummary patch for autolisting * Fix css for autogenerated tables via autosummary * Improve autolist feature * Add toctrees for methods and classes for ignite * Better import for autolist * Add toctrees for methods and classes for contrib package * Fix CSS for autosummary table row height * Fix warnings raised by toctree * Remove all deprecated args, kwargs for v0.5.0 (pytorch#1396) (pytorch#1397) * Remove all deprecated args, kwargs for v0.5.0 (pytorch#1396) * Improve deprecation message of setup_any_logging (pytorch#1396) * Update setup.cfg * Remove module members w/o docstrings from autolist toc tables (pytorch#1401) * Add --color=yes in pytest config (pytorch#1402) * removes styling of function descriptions as requested in pytorch#1256 (pytorch#1399) * removes styling of function descriptions as requested in pytorch#1256 * reverts modifications to the example files * Skip circle ci and GA builds (pytorch#1400) * [WIP] Skip circle ci and GA builds * Fixes swissknife version * Replaced swissknife by sh script * [skip ci] Updated trigger_if_modified.sh script - excluded docs from github actions - added 1.6.0 to pytorch-version-tests * Fixes pytorch#1408, XLA failing tests (pytorch#1412) - Issue is related to xla nightly - Probably related to pytorch/xla#2576 * Added Mypy check as github action (pytorch#1418) * Added Mypy check to as github action * Removed py3.5 * Activate mypy in ignite.metrics (pytorch#1391) * Activate mypy in ignite.metrics * remove num_examples check * fix CR issues * remove init defaults in Accuracy * Remove None assignments in __init__ * improved typing connected with mypy issues Co-authored-by: vfdev <vfdev.5@gmail.com> * Update README.md Badge travis org -> com * add tolerance for tpu in r2 and canberra tests (pytorch#1414) * add tolerance for tpu * autopep8 fix * Reverted test_canberra_metric.py as unnecessary * Update test_r2_score.py * Update test_r2_score.py Co-authored-by: Desroziers <sylvain.desroziers@ifpen.fr> Co-authored-by: sdesrozis <sdesrozis@users.noreply.github.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * Activate mypy ignite contrib metrics (pytorch#1419) * Activate mypy in ignite.contrib.metrics * Add missing type hints in ignite.contrib.metrics * Add missing type hints * Contributing guide (pytorch#1424) * Add materials on how to setup dev env in CONTRIBUTING guide pytorch#1395 - first draft of first-time contributor guide * Add materials on how to setup dev env in CONTRIBUTING guide pytorch#1395 - add in Table of Contents * Add materials on how to setup dev env in CONTRIBUTING guide pytorch#1395 - fix table of contents link * Add materials on how to setup dev env in CONTRIBUTING guide pytorch#1395 - rollback README.md, remove IDE setting * Update CONTRIBUTING.md Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * replace Number type with float; remove unneeded type ignores (pytorch#1425) Co-authored-by: vfdev <vfdev.5@gmail.com> * Update README.md * Added new time profiler `HandlersTimeProfiler` which allows per handler time profiling (pytorch#1398) * added new HandlersTimeProfiler with handler level details and added tests for HandlersTimeProfiler (pytorch#1346) * updated docs and docstring for HandlersTimeProfiler (pytorch#1346) * updated HandlersTimeProfiler to support any events and updated detach mechanism of profiler (pytorch#1346) * updated HandlersTimeProfiler with code improvements and implemented csv export method (pytorch#1346) * updated HandlersTimeProfiler to handle event handler bundle better (pytorch#1346) * HandlersTimeProfiler: added threshold for filtering profiled time for handlers attached to event with filters (pytorch#1346) * HandlersTimeProfiler: add tests and type hints (pytorch#1398) * HandlersTimeProfiler: use FloatTensor for list to tensor conversion (pytorch#1398) * HandlersTimeProfiler: use torch.tensor for list to tensor conversion (pytorch#1398) * HandlersTimeProfiler: remove unnecessary import (pytorch#1398) * HandlersTimeProfiler: move tensor conversion in compute_basic_stats (pytorch#1398) Co-authored-by: vfdev <vfdev.5@gmail.com> * Fix HandlersTimeProfiler example rendering (pytorch#1428) * Fix HandlersTimeProfiler example rendering * Fix WARNINGs: Title underline too short * Add horizontal scrollbars for examples instead of font-size tweaks * Enable horizontal scrollbars for examples globally * Save model with same filename (pytorch#1423) * save model with same filename * Update checkpoint.py * use elif * refactor to have only one comprehension list * refactoring * improve test * autopep8 fix Co-authored-by: Desroziers <sylvain.desroziers@ifpen.fr> Co-authored-by: vfdev <vfdev.5@gmail.com> Co-authored-by: sdesrozis <sdesrozis@users.noreply.github.com> * Some docs nit picking (pytorch#1435) * enable extra flags for stricter type checking (pytorch#1433) * Fixes pytorch#1426 - distrib cpu tests on win (pytorch#1429) * Fixes pytorch#1426 - distrib cpu tests on win * Skip distributed/tpu/multinode_distributed if SKIP_DISTRIB_TESTS=1 * replaced sh by bash * Update pytorch-version-tests.yml * Updated files to ignore for GitHub Actions CI (pytorch#1441) * Added windows gpu test to circle ci (pytorch#1440) * [WIP] Added windows gpu test to circle ci * Updated windows config * Updated conda installation * Updated miniconda install command * Removed conda installation * Updated configuration * Adding max_iters as an optional arg in Engine run (pytorch#1381) * initial draft, adding max_iters as optional args in run * fixed typo * minor bug fixes * resolving failing tests * fixed out-of-place conditional * typo fix * updated docstring for 'run' * added initial tests * (WIP) restructured creating a new state with max_iters * updated tests & docstrings * initial draft, adding max_iters as optional args in run * fixed typo * minor bug fixes * resolving failing tests * fixed out-of-place conditional * typo fix * updated docstring for 'run' * added initial tests * (WIP) restructured creating a new state with max_iters * updated tests & docstrings * added test to check _is_done * updating engine loop condition * autopep8 fix * linting issues * fixed mypy errors * fixed formatting * minor fix & add test for larger max_iters * removed unused typechecking Co-authored-by: thescripted <thescripted@users.noreply.github.com> Co-authored-by: vfdev <vfdev.5@gmail.com> * Updated circleci trigger_if_modified.sh if on master * Fix failing distributed ci (pytorch#1445) * Setup random free port for distrib ci * autopep8 fix Co-authored-by: vfdev-5 <vfdev-5@users.noreply.github.com> * Added torch.cuda.manual_seed_all(seed) (pytorch#1444) * fix ReduceOp typing issue (pytorch#1447) * Update README.md * Updated miniconda setup (pytorch#1449) * Fixed broken coverage (pytorch#1451) * Fixed broken coverage * Updated hvd-tests.yml * Migrated nightly build/release to GitHub Actions (pytorch#1448) (pytorch#1450) * Added nightly build/release action * Updated yml * Updated to conda-incubator/setup-miniconda@v2 * Reverted modifications in other actions * Migrated nightly build/release to GitHub Actions (pytorch#1448) * Added nightly build/release action * Updated yml * Updated to conda-incubator/setup-miniconda@v2 * Reverted modifications in other actions * Fix PyPi upload * Finalized binaries-nightly-release.yml * Updated README * [contributing] add syncing up with the upstream (pytorch#1452) * Update setup.cfg * [contributing] add syncing up with the upstream * Apply suggestions from code review Co-authored-by: vfdev <vfdev.5@gmail.com> * Update CONTRIBUTING.md Co-authored-by: vfdev <vfdev.5@gmail.com> * [ci] create docs.yml * install torch * Activate MyPy in ignite.contrib.engines (pytorch#1416) * Activate mypy in ignite.contrib.engines * Fix review comments * fix extra event too * Update to fix strict errors * Update quickstart.rst (pytorch#1460) * Update quickstart.rst Plz have a look if I am going correct or not. ###rewording sentences to simplify the understanding * Update docs/source/quickstart.rst Co-authored-by: vfdev <vfdev.5@gmail.com> * Update quickstart.rst * Update quickstart.rst * Update docs/source/quickstart.rst Co-authored-by: vfdev <vfdev.5@gmail.com> * Update quickstart.rst Final commit is done. You can review it. Co-authored-by: vfdev <vfdev.5@gmail.com> * [docs] intersphinx update in conf.py * [docs] add missing function in handlers docs (pytorch#1463) * Update setup.cfg * [docs] missing function in handlers docs * [docs] add ignite favicon (pytorch#1462) * Update setup.cfg * [docs] add ignite favicon * Add missing classes and links for docs (pytorch#1461) * Update CONTRIBUTING.md * Update concepts.rst (pytorch#1465) * setup toml, yaml, prettier in pre-commit (pytorch#1468) * Update setup.cfg * [pre-commit] setup yaml in pre-commit hook * [pre-commit] setup toml prettier * [docs] make GIF look good on mobile (pytorch#1470) * Update setup.cfg * [docs] make gif fit on mobile * Update index.rst * use .. raw:: html * Update index.rst Co-authored-by: vfdev <vfdev.5@gmail.com> * Update README.md * Update README.md * Update README.md * Update README.md * [docs] add submodule in engine.rst (pytorch#1464) * Update setup.cfg * [docs] add submodule in engine * [docs] add suggestions, contrib engine docs and 45% width * Update ignite_theme.css * [metrics] speed up SSIM tests (pytorch#1467) * Update setup.cfg * [metrics] update ssim * use np.allclose instead of torch.allclose * Apply suggestions from code review * extract into _test_ssim * extract into scripts * fix path * fix path * fix path * good to go! * [ci] universal conda build (pytorch#1471) * Update setup.cfg * rm conda_build_config * rm conda_build_config * Update docs.yml * Update install_docs_deps.sh Co-authored-by: vcarpani <38493091+vcarpani@users.noreply.github.com> Co-authored-by: Anton Grübel <anton.gruebel@gmail.com> Co-authored-by: Harsh Patel <pharsh58@gmail.com> Co-authored-by: Théo Dumont <theo.dumont@mines-paristech.fr> Co-authored-by: Sylvain Desroziers <sylvain.desroziers@gmail.com> Co-authored-by: Desroziers <sylvain.desroziers@ifpen.fr> Co-authored-by: rex_divakar <rexdivakar@hotmail.com> Co-authored-by: Benjamin Kinga <58235869+thescripted@users.noreply.github.com> Co-authored-by: Taras Savchyn <30748114+trsvchn@users.noreply.github.com> Co-authored-by: trsvchn <trsvchn@users.noreply.github.com> Co-authored-by: RaviTeja Pothana <ravi-teja@live.com> Co-authored-by: Josseline Perdomo <joss.desi@gmail.com> Co-authored-by: Sai Sandeep Mutyala <rageofepicfury@gmail.com> Co-authored-by: Ramesht Shukla <36106177+ramesht007@users.noreply.github.com> Co-authored-by: botbotbot <tkroputa@gmail.com> Co-authored-by: Jeff Yang <ydcjeff@outlook.com> Co-authored-by: Sergey Epifanov <banzaitokyo@gmail.com> Co-authored-by: sdesrozis <sdesrozis@users.noreply.github.com> Co-authored-by: zhxxn <54799042+zhxxn@users.noreply.github.com> Co-authored-by: François COKELAER <francois.cokelaer@gmail.com> Co-authored-by: thescripted <thescripted@users.noreply.github.com> Co-authored-by: vfdev-5 <vfdev-5@users.noreply.github.com> Co-authored-by: Rostyslav Zatserkovnyi <zatserkovnyi.rostyslav@gmail.com> Co-authored-by: Afzal <afzal442@gmail.com>
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.
Fixes #1398 (comment)
Description:
Some css tweaks related to docs example rendering
Check list: