Add api docs for tft.beam.experimental submodule

smokestacklightnin · smokestacklightnin · commit f95779583c72 · 2025-05-13T18:20:21.000-07:00
diff --git a/docs/api_docs/python/tft-beam-experimental.md b/docs/api_docs/python/tft-beam-experimental.md
@@ -0,0 +1,3 @@
+# TensorFlow Transform `tft.beam.experimental` Module
+
+::: tensorflow_transform.beam.experimental
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -73,8 +73,12 @@ plugins:
               - "!_test$"
             extensions:
               - griffe_inherited_docstrings
-          import:
+            preload_modules:
+                - apache_beam
+          load_external_modules: true
+          inventories:
             - https://docs.python.org/3/objects.inv
+            - https://beam.apache.org/releases/pydoc/current/objects.inv
   - mkdocs-jupyter:
       ignore_h1_titles: True
   - caption
@@ -130,3 +134,4 @@ nav:
       - tft.experimental 🧪: api_docs/python/tft-experimental.md
       - tft.beam: api_docs/python/tft-beam.md
       - tft.beam.analyzer_cache: api_docs/python/tft-beam-analyzer-cache.md
+      - tft.beam.experimental 🧪: api_docs/python/tft-beam-experimental.md
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -7,3 +7,4 @@ ruff
 mkdocs-jupyter
 mkdocs-caption
 markdown-grid-tables
+apache-beam[gcp]
diff --git a/tensorflow_transform/beam/experimental/__init__.py b/tensorflow_transform/beam/experimental/__init__.py
@@ -14,3 +14,7 @@
 """Module level imports for tensorflow_transform.beam.experimental."""
 
 from tensorflow_transform.beam.experimental.analyzer_impls import *
+
+__all__ = [
+    "PTransformAnalyzer",
+]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+# TensorFlow Transform `tft.beam.experimental` Module
	`2`	`+`
	`3`	`+::: tensorflow_transform.beam.experimental`