-
Notifications
You must be signed in to change notification settings - Fork 501
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: X-link: facebookresearch/FBGEMM#290 As title Pull Request resolved: #3194 Differential Revision: D63601834 Pulled By: sryap
- Loading branch information
1 parent
3bf1bab
commit d840138
Showing
8 changed files
with
96 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
fbgemm_gpu/docs/src/fbgemm_gpu-python-api/table_batched_embedding_ops.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,18 @@ | ||
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, | ||
split_optimizer_states, | ||
set_learning_rate, | ||
update_hyper_parameters, | ||
set_optimizer_step | ||
|
||
Other API | ||
--------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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<table-batched-embedding-ops-stable-api>` | ||
|
||
- :ref:`Pooled embedding operators<pooled-embedding-operators-stable-api>` | ||
|
||
- :ref:`Pooled embedding modules<pooled-embedding-modules-stable-api>` | ||
|
||
- :ref:`Sparse operators<sparse-ops-stable-api>` | ||
|
||
- :ref:`Jagged tensor operators<jagged-tensor-ops-stable-api>` | ||
|
||
- :ref:`Quantization operators<quantize-ops-stable-api>` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters