Skip to content

Commit 9b208da

Browse files
q10facebook-github-bot
authored andcommitted
Move general documentation into Sphinx (#2227)
Summary: - Move general build, installation, and test documentation into Sphinx Pull Request resolved: #2227 Reviewed By: spcyppt Differential Revision: D52323411 Pulled By: q10 fbshipit-source-id: acf3f71af2241d1da7cd5092d1f3520afa14d367
1 parent 74808cd commit 9b208da

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1013
-862
lines changed

.github/scripts/fbgemm_gpu_build.bash

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ __configure_fbgemm_gpu_build_rocm () {
7777
echo "[BUILD] Architectures list from rocminfo: ${arch_list}"
7878

7979
if [ "$arch_list" == "" ]; then
80+
# It is possible to build FBGEMM_GPU-ROCm on a machine without AMD
81+
# cards, in which case the arch_list will be empty.
8082
echo "[BUILD] rocminfo did not return anything valid!"
8183

8284
# By default, we build just for MI100 and MI250 to save time. This list

.github/workflows/fbgemm_gpu_docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
strategy:
3838
fail-fast: false
3939
matrix:
40-
python-version: [ "3.11" ]
40+
python-version: [ "3.12" ]
4141

4242
steps:
4343
- name: Setup Build Container

fbgemm_gpu/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ See our [Documentation](docs/README.md) for more information.
2020

2121
The full installation instructions
2222
for the CUDA, ROCm, and CPU-only variants of FBGEMM_GPU can be found
23-
[here](docs/InstallationInstructions.md). In addition, instructions for running
24-
example tests and benchmarks can be found [here](docs/TestInstructions.md).
23+
[here](docs/src/general/InstallationInstructions.rst). In addition, instructions for running
24+
example tests and benchmarks can be found [here](docs/src/general/TestInstructions.rst).
2525

2626

2727
## Build Instructions
2828

2929
This section is intended for FBGEMM_GPU developers only. The full build
3030
instructions for the CUDA, ROCm, and CPU-only variants of FBGEMM_GPU can be
31-
found [here](docs/BuildInstructions.md).
31+
found [here](docs/src/general/BuildInstructions.rst).
3232

3333

3434
## Join the FBGEMM_GPU Community

fbgemm_gpu/codegen/embedding_bounds_check_host.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
using Tensor = at::Tensor;
1818

19-
///@defgroup embedding-cuda Embedding CUDA Operators
19+
/// @defgroup embedding-cuda Embedding CUDA Operators
2020

2121
///@ingroup embedding-cuda
2222
void bounds_check_indices_cuda(

fbgemm_gpu/codegen/embedding_bounds_check_host_cpu.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
using Tensor = at::Tensor;
1818
using namespace fbgemm_gpu;
1919

20-
///@defgroup embedding-cpu Embedding CPU Operators
20+
/// @defgroup embedding-cpu Embedding CPU Operators
2121
///
2222

2323
namespace {

fbgemm_gpu/codegen/embedding_forward_quantized_host.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ void process_uvm_cache_stats(
184184
} // namespace
185185
#endif
186186

187-
///@defgroup embedding-cuda Embedding CUDA Operators
187+
/// @defgroup embedding-cuda Embedding CUDA Operators
188188
///
189189

190190
Tensor int_nbit_split_embedding_codegen_forward_unweighted_cuda(

fbgemm_gpu/codegen/embedding_forward_quantized_host_cpu.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
using Tensor = at::Tensor;
2525
using namespace fbgemm_gpu;
2626

27-
///@defgroup embedding-cpu Embedding CPU Operators
27+
/// @defgroup embedding-cpu Embedding CPU Operators
2828
///
2929

3030
Tensor int_nbit_split_embedding_codegen_forward_unweighted_cpu(

0 commit comments

Comments
 (0)