diff --git a/docs/getting_started.md b/docs/getting_started.md index b4fa8aa4..6f69d5a9 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -71,5 +71,7 @@ Learn how to incorporate expert priors for more efficient hyperparameter selecti * **[Benefiting NePS State and Optimizers with custom runtime](examples/experimental/ask_and_tell_example.md)**: Learn how to use AskAndTell, an advanced tool for leveraging optimizers and states while enabling a custom runtime for trial execution. +- **[Integration with TensorBoard](examples/convenience/neps_tblogger_tutorial.md)**: Discover how to leverage NePS's built-in TensorBoard support and seamlessly incorporate your own custom TensorBoard data for enhanced experiment tracking. + * **[Additional NePS Examples](examples/index.md)**: Explore more examples, including various use cases and advanced configurations in NePS. diff --git a/docs/index.md b/docs/index.md index 569159a4..072190c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -88,7 +88,11 @@ neps.run( pipeline_space=pipeline_space, root_directory="path/to/save/results", # Replace with the actual path. evaluations_to_spend=100, + write_summary_to_disk=True, ) + +# 4. status information about a neural pipeline search run, using: +# python -m neps.status path/to/save/results ``` ## Examples @@ -103,6 +107,8 @@ Discover how NePS works through these examples: - **[Benefiting NePS State and Optimizers with custom runtime](examples/experimental/ask_and_tell_example.md)**: Learn how to use AskAndTell, an advanced tool for leveraging optimizers and states while enabling a custom runtime for trial execution. +- **[Integration with TensorBoard](examples/convenience/neps_tblogger_tutorial.md)**: Discover how to leverage NePS's built-in TensorBoard support and seamlessly incorporate your own custom TensorBoard data for enhanced experiment tracking. + - **[Additional NePS Examples](examples/index.md)**: Explore more examples, including various use cases and advanced configurations in NePS. ## Contributing diff --git a/docs/reference/analyse.md b/docs/reference/analyse.md index 2edb4ed4..95e903ab 100644 --- a/docs/reference/analyse.md +++ b/docs/reference/analyse.md @@ -82,6 +82,7 @@ Details include configuration hyperparameters and any returned result and cost f The `best_config_trajectory.txt` contains logging of the incumbent trajectory. The `best_config.txt` records current incumbent. + # TensorBoard Integration In NePS we replaced the traditional TensorBoard `SummaryWriter` with the `ConfigWriter` to streamline the logging process. This integration enhances the ability to visualize and diagnose hyperparameter optimization workflows, providing detailed insights into metrics and configurations during training.