Skip to content

Updating getting started to add code for the setup_tb_logger #3735

@aaishwarymishra

Description

@aaishwarymishra

📚 Documentation

We recently moved several logger setup helper methods to ignite/handlers/logger_utils.py. These utilities are designed to simplify the user experience, allowing for a basic logger setup with just a single line of code.

To improve the onboarding experience for new users, we should update the Getting Started tutorial to feature these helpers. Specifically, we want to introduce setup_tb_logger so beginners can implement TensorBoard logging more efficiently.

Location

File: src/tutorials/beginner/01-getting-started.md

Proposed Changes

Code Enhancement: Add code for setup_tb_logger as alternative method of attaching loggers.

Contextual Explanation: Briefly explain that this helper automates the attachment of common events (like logging loss and metrics) to the logger.

You can find info about the TensorboardLogger here and for the setup_tb_logger here

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions