From 262beee3d21b7b0119930a15a4093a1c92a616d2 Mon Sep 17 00:00:00 2001 From: Danielle Pintz Date: Sat, 1 Jul 2023 17:02:16 -0700 Subject: [PATCH] Consolidate meta callbacks and oss callbacks in docs Summary: Instead of having two sections for callbacks in the docs, one for OSS and one for Meta we can combine these into one section for better discoverability of callbacks. The one downside of this change is it exposes some Meta-internal names to OSS. Differential Revision: D46847563 fbshipit-source-id: 6b03c0885199188d3cb6456cde4752a37a56e1a5 --- docs/source/framework/callbacks.rst | 14 ++++++++++++++ docs/source/index.rst | 9 --------- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/source/framework/callbacks.rst b/docs/source/framework/callbacks.rst index acbce497e7..6131acfc22 100644 --- a/docs/source/framework/callbacks.rst +++ b/docs/source/framework/callbacks.rst @@ -30,3 +30,17 @@ We offer several pre-written callbacks which are ready to be used out of the box TorchSnapshotSaver TQDMProgressBar TrainProgressMonitor + +.. fbcode:: + + .. currentmodule:: torchtnt.meta.framework.callbacks + + .. autosummary:: + :nosignatures: + :toctree: generated/ + :template: class_template.rst + + BaseHiveWriter + ModelStoreCheckpointer + StuckJobDetector + ZoomerProfiler diff --git a/docs/source/index.rst b/docs/source/index.rst index 117db32875..1848ea8a7e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -78,15 +78,6 @@ Documentation utils/data utils/loggers -.. fbcode:: - - .. toctree:: - :maxdepth: 2 - :caption: Framework (Meta) - :glob: - - meta/framework/callbacks - .. fbcode:: .. toctree::