Skip to content

Commit 22b4beb

Browse files
committed
update README.
1 parent adfcf96 commit 22b4beb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ GGNN is based on the method proposed in the paper [GGNN: Graph-based GPU Nearest
1212
by Fabian Groh, Lukas Ruppert, Patrick Wieschollek, and Hendrik P.A. Lensch.
1313
The original/official code corresponding to the published paper can be found in the [release_0.5](https://github.com/cgtuebingen/ggnn/tree/release_0.5) branch.
1414

15-
<!-- #ToDo: Insert link to docu
16-
For more detailed information see our [documentation]().-->
15+
For more detailed information see our [documentation](https://ggnn.readthedocs.io/en/latest/).
1716

1817
## Installing the Python Module
1918

@@ -79,8 +78,7 @@ export CXX=g++-10
7978
export CUDAHOSTCXX=g++-10
8079
```
8180

82-
<!--#ToDo: Insert link to Installation
83-
For installation in C++, please see the [documentation]().-->
81+
For installation details, please see the [documentation](https://ggnn.readthedocs.io/en/latest/install.html).
8482

8583
## Example Usage
8684

@@ -138,8 +136,10 @@ print('indices:', indices[:5], '\n squared dists:', dists[:5], '\n')
138136

139137
```
140138

141-
<!--#ToDo: Insert link to Usage
142-
For more examples in Python and in C++ see the [examples]() folder. For more information about the parameters, on how to deal with data that is already on a GPU and on how to utilize multiple GPUs, check out the [documentation](). We also provide scripts that load typical [benchmark datasets]().-->
139+
For more examples in Python and in C++ see the [examples](https://github.com/cgtuebingen/ggnn/tree/release_0.9/examples) folder.
140+
For more information about the parameters, on how to deal with data that is already on a GPU and on how to utilize multiple GPUs,
141+
check out the [documentation](https://ggnn.readthedocs.io/en/latest/usage_python.html).
142+
We also provide scripts that load and process typical [benchmark datasets](https://ggnn.readthedocs.io/en/latest/benchmarking.html).
143143

144144

145145
## Capabilities and Limitations

0 commit comments

Comments
 (0)