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
pytorch · Jul 2, 2023 · 262beee · 262beee
1 parent 1297517
commit 262beee
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 9 deletions.
diff --git 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
@@ -78,15 +78,6 @@ Documentation
    utils/data
    utils/loggers
 
-.. fbcode::
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: Framework (Meta)
-      :glob:
-
-      meta/framework/callbacks
-
 .. fbcode::
 
    .. toctree::