diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/jagged_tensor_ops.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/jagged_tensor_ops.rst index 92e8f1148..a85168bfc 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/jagged_tensor_ops.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/jagged_tensor_ops.rst @@ -3,14 +3,22 @@ Jagged Tensor Operators .. automodule:: fbgemm_gpu +.. _jagged-tensor-ops-stable-api: + +Stable API +---------- + +.. autofunction:: torch.ops.fbgemm.jagged_to_padded_dense + +Other API +--------- + .. autofunction:: torch.ops.fbgemm.jagged_2d_to_dense .. autofunction:: torch.ops.fbgemm.jagged_1d_to_dense .. autofunction:: torch.ops.fbgemm.dense_to_jagged -.. autofunction:: torch.ops.fbgemm.jagged_to_padded_dense - .. autofunction:: torch.ops.fbgemm.jagged_dense_elementwise_add .. autofunction:: torch.ops.fbgemm.jagged_dense_elementwise_add_jagged_output diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_modules.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_modules.rst index 654373f40..7970ce6f9 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_modules.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_modules.rst @@ -3,5 +3,13 @@ Pooled Embedding Modules .. automodule:: fbgemm_gpu +.. _pooled-embedding-modules-stable-api: + +Stable API +---------- + .. autoclass:: fbgemm_gpu.permute_pooled_embedding_modules.PermutePooledEmbeddings :members: __call__ + +Other API +--------- diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_ops.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_ops.rst index 52e2fd47d..9e9d545d7 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_ops.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/pooled_embedding_ops.rst @@ -3,6 +3,14 @@ Pooled Embedding Operators .. automodule:: fbgemm_gpu +.. _pooled-embedding-operators-stable-api: + +Stable API +---------- + .. autofunction:: torch.ops.fbgemm.merge_pooled_embeddings .. autofunction:: torch.ops.fbgemm.permute_pooled_embs + +Other API +--------- diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/quantize_ops.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/quantize_ops.rst index df2a6c2d7..3b47f8bcd 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/quantize_ops.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/quantize_ops.rst @@ -3,4 +3,12 @@ Quantization Operators .. automodule:: fbgemm_gpu +.. _quantize-ops-stable-api: + +Stable API +---------- + .. autofunction:: torch.ops.fbgemm.FloatOrHalfToFusedNBitRowwiseQuantizedSBHalf + +Other API +--------- diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/sparse_ops.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/sparse_ops.rst index b95b6dda4..e5a4213f7 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/sparse_ops.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/sparse_ops.rst @@ -3,6 +3,11 @@ Sparse Operators .. automodule:: fbgemm_gpu +.. _sparse-ops-stable-api: + +Stable API +---------- + .. autofunction:: torch.ops.fbgemm.permute_2D_sparse_data .. autofunction:: torch.ops.fbgemm.permute_1D_sparse_data @@ -17,4 +22,6 @@ Sparse Operators .. autofunction:: torch.ops.fbgemm.keyed_jagged_index_select_dim1 -.. autofunction:: torch.ops.fbgemm.block_bucketize_sparse_features \ No newline at end of file +.. autofunction:: torch.ops.fbgemm.block_bucketize_sparse_features + +Other API diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/table_batched_embedding_ops.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/table_batched_embedding_ops.rst index bbd39d873..9b5453786 100644 --- a/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/table_batched_embedding_ops.rst +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-python-api/table_batched_embedding_ops.rst @@ -1,6 +1,11 @@ Table Batched Embedding (TBE) Training Module ============================================= +.. _table-batched-embedding-ops-stable-api: + +Stable API +---------- + .. autoclass:: fbgemm_gpu.split_table_batched_embeddings_ops_training.SplitTableBatchedEmbeddingBagsCodegen :members: forward, split_embedding_weights, @@ -8,3 +13,6 @@ Table Batched Embedding (TBE) Training Module set_learning_rate, update_hyper_parameters, set_optimizer_step + +Other API +--------- diff --git a/fbgemm_gpu/docs/src/fbgemm_gpu-stable-api/python_api.rst b/fbgemm_gpu/docs/src/fbgemm_gpu-stable-api/python_api.rst new file mode 100644 index 000000000..b506ba82f --- /dev/null +++ b/fbgemm_gpu/docs/src/fbgemm_gpu-stable-api/python_api.rst @@ -0,0 +1,38 @@ +FBGEMM_GPU Stable Python API +============================ + +We provide the stable API support in FBGEMM_GPU v1. The following outlines our +supports: + +- API backward compatibility guarantees via thorough testing. We guarantee that + our stable APIs will be backward compatible within a major version, meaning + that the stable APIs for v1.0.0 will be compatible with every future v1.x.x + release. + +- Enhanced documentation, ensuring that every stable API has comprehensive and + up-to-date documentation. + +- No explicit functionality guarantees. Functionality guarantees are only + provided through unit testing framework. We do NOT guarantee any + functionalities that are NOT explicitly tested and documented in our unit + tests. + +- No performance guarantees. However, we are committed to providing support on + a best-effort basis. + +Stable APIs +----------- + +Our stable APIs can be found via the links below: + +- :ref:`Table batched embedding (TBE) modules` + +- :ref:`Pooled embedding operators` + +- :ref:`Pooled embedding modules` + +- :ref:`Sparse operators` + +- :ref:`Jagged tensor operators` + +- :ref:`Quantization operators` diff --git a/fbgemm_gpu/docs/src/index.rst b/fbgemm_gpu/docs/src/index.rst index f5b4cfb07..2b92f0d3d 100644 --- a/fbgemm_gpu/docs/src/index.rst +++ b/fbgemm_gpu/docs/src/index.rst @@ -56,6 +56,14 @@ Table of Contents fbgemm_gpu-overview/jagged-tensor-ops/JaggedTensorOps.rst +.. _fbgemm.toc.api.stable: + +.. toctree:: + :maxdepth: 1 + :caption: FBGEMM Stable API + + fbgemm_gpu-stable-api/python_api.rst + .. _fbgemm.toc.api.cpp: .. toctree::