Skip to content

Commit fa39fd0

Browse files
committed
Elaborate README.md
1 parent 609a87a commit fa39fd0

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# pytorch-cpp-extension
22

3-
An example of writing a C++ extension for PyTorch.
3+
An example of writing a C++ extension for PyTorch. See
4+
[here](http://pytorch.org/docs/0.3.1/notes/cpp-extensions.html) for the accompanying tutorial.
5+
6+
There are a few "sights" you can metaphorically visit in this repository:
7+
8+
- Inspect the C++ and CUDA extensions in the `cpp/` and `cuda/` folders,
9+
- Build C++ and/or CUDA extensions by going into the `cpp/` or `cuda/` folder and executing `python setup.py install`,
10+
- JIT-compile C++ and/or CUDA extensions by going into the `cpp/` or `cuda/` folder and calling `python jit.py`, which will JIT-compile the extension and load it,
11+
- Benchmark Python vs. C++ vs. CUDA by running `python benchmark.py {py, cpp, cuda} [--cuda]`,
12+
- Run gradient-checks on the code by running `python grad_check.py {py, cpp, cuda}`.
13+
14+
## Authors
15+
16+
[Peter Goldsborough](https://github.com/goldsborough)

0 commit comments

Comments
 (0)