Skip to content

Improve docs for torch and torch.Tensor#3969

Merged
soumith merged 2 commits intopytorch:masterfrom
ssnl:squeeze_doc
Dec 1, 2017
Merged

Improve docs for torch and torch.Tensor#3969
soumith merged 2 commits intopytorch:masterfrom
ssnl:squeeze_doc

Conversation

@ssnl
Copy link
Copy Markdown
Collaborator

@ssnl ssnl commented Dec 1, 2017

Makes the documents overall much more consistent. Changes include:

  1. raw docstrings.
  2. improves / add some math expressions
  3. makes doc for certain methods clearer, e.g. chunk and split
  4. use a consistent format for tensor shape
  5. [Tensor, Tensor, tensor, etc.] -> tensor when not referring the the class
  6. fixes several formatting errors caused by newline

Copy link
Copy Markdown
Member

@colesbury colesbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Comment thread torch/functional.py Outdated

This comment was marked as off-topic.

@soumith soumith merged commit fe12ac5 into pytorch:master Dec 1, 2017
@ssnl ssnl deleted the squeeze_doc branch December 1, 2017 20:01
@colesbury
Copy link
Copy Markdown
Member

@ssnl can please fix the lint errors?

https://travis-ci.org/pytorch/pytorch/jobs/310181860

@ssnl
Copy link
Copy Markdown
Collaborator Author

ssnl commented Dec 1, 2017

Sorry about those. Fixing right now!

@ssnl
Copy link
Copy Markdown
Collaborator Author

ssnl commented Dec 1, 2017

For some of those.. if I break the line, sphinx will generate weird format. I tried to look for other workarounds but didn't find any. I'll do some more search.

@soumith soumith added the 0.3.1 label Feb 4, 2018
soumith pushed a commit that referenced this pull request Feb 7, 2018
* doc overhaul

* update split doc
laurentdupin pushed a commit to laurentdupin/pytorch that referenced this pull request Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants