Skip to content

Add setup_tb_logging example to getting started tutorial#97

Merged
vfdev-5 merged 2 commits intopytorch-ignite:mainfrom
zeel2104:docs-setup-tb-logger-getting-started
Apr 24, 2026
Merged

Add setup_tb_logging example to getting started tutorial#97
vfdev-5 merged 2 commits intopytorch-ignite:mainfrom
zeel2104:docs-setup-tb-logger-getting-started

Conversation

@zeel2104
Copy link
Copy Markdown
Contributor

Summary

  • add setup_tb_logging import to the Getting Started tutorial
  • include a minimal helper-based TensorBoard logging example as an alternative to manual logger attachment
  • explain that the helper automatically attaches common logging events such as training metrics, learning rate, and evaluator metrics
  • mirror the helper-based option in the complete code section as a commented alternative

Notes

  • this updates the source notebook in pytorch-ignite/examples:
    tutorials/beginner/01-getting-started.ipynb
  • the docs site markdown in pytorch-ignite.ai is generated from this notebook, so updating the notebook is the correct source change

"from ignite.metrics import Accuracy, Loss\n",
"from ignite.handlers import ModelCheckpoint\n",
"from ignite.contrib.handlers import TensorboardLogger, global_step_from_engine"
"from ignite.contrib.handlers import TensorboardLogger, global_step_from_engine\n",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"from ignite.contrib.handlers import TensorboardLogger, global_step_from_engine\n",
"from ignite.handlers import TensorboardLogger, global_step_from_engine\n",

@@ -657,6 +685,7 @@
"from ignite.metrics import Accuracy, Loss\n",
"from ignite.handlers import ModelCheckpoint\n",
"from ignite.contrib.handlers import TensorboardLogger, global_step_from_engine\n",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"from ignite.contrib.handlers import TensorboardLogger, global_step_from_engine\n",
"from ignite.handlers import TensorboardLogger, global_step_from_engine\n",

@vfdev-5
Copy link
Copy Markdown
Member

vfdev-5 commented Apr 20, 2026

@zeel2104 thanks for the PR, can you please address the comments of @aaishwarymishra, thanks!

@zeel2104
Copy link
Copy Markdown
Contributor Author

@vfdev-5
Updated both occurrences to import TensorboardLogger and global_step_from_engine from ignite.handlers. Thanks!

@aaishwarymishra
Copy link
Copy Markdown

@vfdev-5 I think this can be merged.

@vfdev-5 vfdev-5 merged commit 1a0e547 into pytorch-ignite:main Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants