Skip to content

Commit

Permalink
Remove aten doc/ folder (#11158)
Browse files Browse the repository at this point in the history
Summary:
ATen's doc/ folder is manually maintained and can thus cause confusion with the generated file. We now have proper online documentation for ATen, which is superior to ATen doc/. Let's delete ATen/doc.

ezyang apaszke soumith
Pull Request resolved: #11158

Differential Revision: D9618782

Pulled By: goldsborough

fbshipit-source-id: 0ef14f84947601a0589aa4a41e5c8619783426fe
  • Loading branch information
goldsborough authored and facebook-github-bot committed Aug 31, 2018
1 parent 3081c8e commit 5987b44
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 4,744 deletions.
6 changes: 3 additions & 3 deletions aten/README.md
Expand Up @@ -12,7 +12,7 @@ does not include templates. That is, there is one `Tensor` type. It can hold a
CPU or CUDA Tensor, and the tensor may have Doubles, Float, Ints, etc. This design
makes it easy to write generic code without templating everything.

See the _generated_ [`Tensor.h` file](doc/Tensor.h) and [`Functions.h` file](doc/Functions.h) for the provided API. Excerpt:
See https://pytorch.org/cppdocs for the provided API. Excerpt:
```c++
Tensor atan2(const Tensor & other) const;
Tensor & atan2_(const Tensor & other);
Expand Down Expand Up @@ -88,7 +88,7 @@ for(auto i = 0; i < 100000; i++) {

Expressions like `CUDA(kFloat)` are first-class `at::Type` objects that represent
the type of a Tensor and are used to create Tensors when their type cannot be
inferred. See the _generated_ [Type header](doc/Type.h) for its API.
inferred.

See more in [sample files](src/ATen/test).

Expand Down Expand Up @@ -165,7 +165,7 @@ behave as normal tensors.
### Scalars and zero-dimensional tensors
In addition to the `Tensor` objects, ATen also includes `Scalar`s that represent a single number.
Like a Tensor, Scalars are dynamically typed and can hold any one of ATen's [number types](doc/Type.h).
Like a Tensor, Scalars are dynamically typed and can hold any one of ATen's number types.
Scalars can be implicitly constructed from C++ number types. Scalars are needed because some functions like `addmm` take numbers along with Tensors and expect these
numbers to be the same dynamic type as the tensor. They are also used in the API to indicate places where
a function will _always_ return a Scalar value, like `sum`.
Expand Down

0 comments on commit 5987b44

Please sign in to comment.