Commit Graph

268 Commits

Author SHA1 Message Date
Daiki Katsuragawa
3acd6b7359 Document formatting (#42065)
Summary:
Apply syntax highlighting to the command in `README.md`. This makes `README.md` easier to read.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/42065

Reviewed By: pbelevich

Differential Revision: D22753418

Pulled By: mrshenli

fbshipit-source-id: ebfa90fdf60478c34bc8a7284d163e0254cfbe3b
2020-07-28 08:27:42 -07:00
Hong Xu
183b43f323 Clarify Python 3.5 is the minimum supported version in the installation section. (#41937)
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/41937

Reviewed By: izdeby

Differential Revision: D22702924

Pulled By: mrshenli

fbshipit-source-id: 67306435e80f80236b585f1d5406444daec782d6
2020-07-23 15:54:56 -07:00
Yanan Cao
445128d0f2 Add PyTorch Glossary (#40639)
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/40639

Differential Revision: D22421207

Pulled By: gmagogsfm

fbshipit-source-id: 7df8bfc85e28bcf1fb08892a3671e7a9cb0dee9c
2020-07-07 19:53:44 -07:00
Sebastian Messmer
c790476384 Back out "Revert D22072830: [wip] Upgrade msvc to 14.13" (#40594)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/40594

Original commit changeset: 901de185e607
ghstack-source-id: 106642590

Test Plan: oss ci

Differential Revision: D22247269

fbshipit-source-id: be0c64d1a579f8aa3999cb84a9d20488095a81bd
2020-06-25 17:19:33 -07:00
Sebastian Messmer
d8ec19bc03 Revert D22072830: [wip] Upgrade msvc to 14.13
Test Plan: revert-hammer

Differential Revision:
D22072830

Original commit changeset: 6fa03725f3fe

fbshipit-source-id: 901de185e607810cb3871c2e4d23816848c97f4b
2020-06-23 16:13:03 -07:00
Sebastian Messmer
d21ee2de66 [wip] Upgrade msvc to 14.13 (#40109)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/40109

ghstack-source-id: 106426627

Test Plan: oss CI

Differential Revision: D22072830

fbshipit-source-id: 6fa03725f3fe272795553c9c4acf46130b8c6039
2020-06-23 13:05:36 -07:00
Srimukh Sripada
a8ab78c815 Added a link to Contribution guide in Readme (#40353)
Summary:
Added a link to `CONTRIBUTION.md` in `README.md` for easy reference.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/40353

Differential Revision: D22167138

Pulled By: ezyang

fbshipit-source-id: fe7b7f190c8135fdd2e71696c1cf8d84bcd40fc6
2020-06-22 13:20:06 -07:00
wangxiyuan
12cf8390e6 Update aarch64 CI badge (#39914)
Summary:
This PR added python37 and python38 badge for aarch64 build  CI.

You can preview the badge here: https://github.com/wangxiyuan/pytorch/tree/update_aarch64_ci

The build job is passing now since we use CLANG instead GCC for building.

Using GCC still hit error which is mentioned in https://github.com/pytorch/pytorch/issues/33124

Related: https://github.com/pytorch/pytorch/issues/39558
Pull Request resolved: https://github.com/pytorch/pytorch/pull/39914

Differential Revision: D22068834

Pulled By: ezyang

fbshipit-source-id: d8a2ec795408850ec6eba3af7b29ddfeb3cbea38
2020-06-16 09:22:42 -07:00
wangxiyuan
f1e6e56641 Add aarch64 ci badge (#39698)
Summary:
This PR added a third-party aarch64 CI badge. It's CPU only currently for building pytorch master branch on python3.6 and Ubuntu 18.04. This CI is provided by OpenLab[1]

The build job runs once everyday at UTC0000

You can preview the badge here[2]

The build failed because of a known issue: https://github.com/pytorch/pytorch/issues/33124

More python version and GPU support will be added in the future.

This fixes pytorch/pytorch#39558.

1: https://openlabtesting.org/
2: https://github.com/wangxiyuan/pytorch/tree/add_aarch64_ci_badge
Pull Request resolved: https://github.com/pytorch/pytorch/pull/39698

Differential Revision: D21960607

Pulled By: ezyang

fbshipit-source-id: 15d5c06e455ed1b5cf69c3b33906c098cb539f87
2020-06-09 14:02:59 -07:00
David Clissold
ac25267753 fix build table for ppc64le (#39475)
Summary:
This corrects the build info for ppc64le in the main README.

I am opening this PR before renaming the build job.  (So, the "live" master README has the correct "live" link and the PR does not.)
Immediately after submitting the PR, I will correct the name of the build job.  This will make the new PR link correct, and the current "master" link will briefly appear broken until this PR gets merged.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/39475

Differential Revision: D21883184

Pulled By: malfet

fbshipit-source-id: 148353b632448c98e5aff560d31642328afe7963
2020-06-04 08:31:38 -07:00
ShawnZhong
fc4dfbf700 Remove reference of CUDA < 9.2 (#38977)
Summary:
Since CUDA < 9.2 is no longer supported (See https://github.com/pytorch/pytorch/pull/36848, https://github.com/pytorch/pytorch/pull/36846), this PR updates the required CUDA version in README.md to avoid confusion.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/38977

Differential Revision: D21722965

Pulled By: ezyang

fbshipit-source-id: 626772f4303d023918dda34a620d95693174d97f
2020-05-26 09:23:26 -07:00
Rishit Dagli
b04c07a67c Added a Resource section to README (#38547)
Summary:
Added the following entries in the newly made resources section in README:

* [PyTorch.org](https://pytorch.org/)
* [PyTorch Tutorials](https://pytorch.org/tutorials/)
* [PyTorch Examples](https://github.com/pytorch/examples)
* [PyTorch Models](https://pytorch.org/hub/)
* [Intro to Deep Learning with PyTorch from Udacity](https://www.udacity.com/course/deep-learning-pytorch--ud188)
* [Intro to Machine Learning with PyTorch from Udacity](https://www.udacity.com/course/intro-to-machine-learning-nanodegree--nd229)
* [Deep Neural Networks with PyTorch from Coursera](https://www.coursera.org/learn/deep-neural-networks-with-pytorch)
* [PyTorch Twitter](https://twitter.com/PyTorch)
* [PyTorch Blog](https://pytorch.org/blog/)
* [PyTorch YouTube](https://www.youtube.com/channel/UCWXI5YeOsh03QvJ59PMaXFw)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/38547

Differential Revision: D21601647

Pulled By: jerryzh168

fbshipit-source-id: 2453312401386aa59c3b6c62b9f735dc8eb4947f
2020-05-15 15:54:10 -07:00
Rak Alexey
5c628ddbd0 Fix README for installation from source (#37301)
Summary:
I think, it's help faster compile pytorch from source without errors about incompatible compiler(such as: unsupported GNU version! gcc versions later than 8 are not supported!)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/37301

Differential Revision: D21396682

Pulled By: ngimel

fbshipit-source-id: 5e21c36ee550424e820f3aa6e6131ca858994ae4
2020-05-05 10:15:21 -07:00
Bharat Raghunathan
0c2a72ec41 Update README to include few (missing?) links (#37714)
Summary:
Update of README
Pull Request resolved: https://github.com/pytorch/pytorch/pull/37714

Differential Revision: D21393786

Pulled By: ngimel

fbshipit-source-id: 8ae12b38989cbfcdd4d69db1c1ab3bbac0e0db61
2020-05-04 18:34:58 -07:00
Orion Reblitz-Richardson
2d8dbcd3ef Remove python2 and 3.5 from requirements.txt, README and docs (#35677)
Summary:
Some more cleanup now that we no longer support python2 or 3.5 on master and eventually PyTorch 1.6 release.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/35677

Differential Revision: D20838097

Pulled By: orionr

fbshipit-source-id: 95d553a1e8769f3baa395e0bc6d4ce7cd93236e9
2020-04-03 11:05:43 -07:00
Bruce Lin
34688d2c48 Add brand guidelines link (#34503)
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/34503

Differential Revision: D20349273

Pulled By: soumith

fbshipit-source-id: 6b085377741ace5d200ca0d536de433b9bb7825c
2020-03-09 15:55:52 -07:00
Marc Lacayo
99228086a6 Added missing period in README.
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/32723

Differential Revision: D19607256

Pulled By: mlacayo

fbshipit-source-id: 2993014d4d90fa26acd5bc01ed7494cc43a29a62
2020-01-28 16:25:04 -08:00
Eli Uriegas
f0c85571ed docker: Refactor Dockerfile process for official images (#32515)
Summary:
## Commit Message:

Refactors Dockerfile to be as parallel as possible with caching and adds a new Makefile to build said Dockerfile.

Also updated the README.md to reflect the changes as well as updated some of the verbage around running our latest Docker images.

Adds the new Dockerfile process to our CircleCI workflows

## How to build:

Building the new images is pretty simple, just requires `docker` > 18.06 since the new build process relies on `buildkit` caching and multi-stage build resolving.

### Development images
For `runtime` images:
```
make -f docker.Makefile runtime-image
```

For `devel` images:
```
make -f docker.Makefile devel-image
```

Builds are tagged as follows:
```bash
docker.io/${docker_user:-whoami}/pytorch:$(git describe --tags)-${image_type}
```

Example:
```
docker.io/seemethere/pytorch:v1.4.0a0-2225-g9eba97b61d-runtime
```

### Official images

Official images are the ones hosted on [`docker.io/pytorch/pytorch`](https://hub.docker.com/r/pytorch/pytorch)

To do official images builds you can simply add set the `BUILD_TYPE` variable to `official` and it will do the correct build without building the local binaries:

Example:
```
make -f docker.Makefile BUILD_TYPE=official runtime-image
```

## How to push:

Pushing is also super simple (And will automatically tag the right thing based off of the git tag):

```
make -f docker.Makefile runtime-push
make -f docker.Makefile devel-push
```
Signed-off-by: Eli Uriegas <eliuriegas@fb.com>
Pull Request resolved: https://github.com/pytorch/pytorch/pull/32515

Differential Revision: D19558619

Pulled By: seemethere

fbshipit-source-id: a06b25cd39ae9890751a60f8f36739ad6ab9ac99
2020-01-24 10:27:20 -08:00
David Clissold
b26ee54176 For ppc64le, stop presenting the python 2.7 builds (we will no longer… (#32315)
Summary:
For ppc64le, we no longer plan to run regular builds on Python 2.7, and we wish to stop
publicizing the build status for those two builds (ppc64le/CPU and ppc64le/GPU each on py27).

This pull request simply removes the build status links for these two builds, replacing them
with a generic dash character (consistent with other un-publicized builds within the table).
Pull Request resolved: https://github.com/pytorch/pytorch/pull/32315

Differential Revision: D19435939

Pulled By: soumith

fbshipit-source-id: c9f31e7acba83e42f6a758ac011bbef36fd8aaa0
2020-01-16 13:49:40 -08:00
Sebastian Meßmer
d64e2581cc Add list of supported XCode/CUDA versions to README
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/30407

Differential Revision: D18689043

Pulled By: smessmer

fbshipit-source-id: cd772451ef31356ed3045ebb1a9c4f5e5e91bb45
2019-11-25 14:52:42 -08:00
James Webber
3bffb730b6 Add note about when to install typing package (#29103)
Summary:
Was just trying to build pytorch from source and had a small hiccup because the instructions say to `conda install typing`. Because `typing` is a built-in module in recent Python 3 versions, conda interpreted that to mean that I want Python 2. So I added a note to the docs.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/29103

Differential Revision: D18294139

Pulled By: soumith

fbshipit-source-id: 621a2f62ebe870520197baec8f8bcdc1a0c57de9
2019-11-03 19:38:55 -08:00
Aleks Borovtsov
cd3ed4db76 Update README.md (#28971)
Summary:
Fixed some grammar.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/28971

Differential Revision: D18265791

Pulled By: soumith

fbshipit-source-id: 778ab3e8a31f5f520a048c089c719c618427eaa6
2019-10-31 21:04:21 -07:00
Hyeonguk Ryu
110a931752 Change from HTTP to HTTPS
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/28333

Differential Revision: D18143824

Pulled By: soumith

fbshipit-source-id: 613fd2219814addc850c3b9fe7ebfd8510a5e5c8
2019-10-25 13:13:30 -07:00
Andreas Koepf
4b64ada531 Fix typo (#28281)
Summary:
I know this is really a minor one and the list of people to mention will be significantly larger in the future. Nevertheless I would love to see my name written in correct international spelling (the strange German o-umlaut in my name becomes oe).
Pull Request resolved: https://github.com/pytorch/pytorch/pull/28281

Differential Revision: D18007518

Pulled By: ezyang

fbshipit-source-id: 1d03065636d7f65ac6b376690256c0d021482958
2019-10-18 08:51:12 -07:00
Sebastian Meßmer
32c56747f7 Mention C++14 in the README (#26670)
Summary:
Technically, we don't need a C++14 compiler yet, but we will soon stop support for GCC 4. Requiring a "C++14" compiler excludes GCC 4, so it is a defensive statement. Some time later, we will actually require a C++14 compiler.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/26670

Differential Revision: D17907257

Pulled By: smessmer

fbshipit-source-id: 5363d714f8d93597db008135f681b2e14d052fa0
2019-10-14 08:12:42 -07:00
jonmoon74
1c2cb6d523 Edits to ReadMe file (#27808)
Summary:
Grammar edits to the Readme file to make it read better in English
Pull Request resolved: https://github.com/pytorch/pytorch/pull/27808

Differential Revision: D17901414

Pulled By: soumith

fbshipit-source-id: 02e67289dafaf9280cb1c3bb2f37087cd134cc23
2019-10-13 17:09:02 -07:00
Abbas
16ece1c9da Fixed typos and grammatical errors (#27465)
Summary:
Fixes https://github.com/pytorch/pytorch/issues/27443
Pull Request resolved: https://github.com/pytorch/pytorch/pull/27465

Differential Revision: D17810732

Pulled By: pietern

fbshipit-source-id: b8a62dd086a4f4a61c9aa6acfa495cf822995604
2019-10-08 09:31:45 -07:00
Nathan Goldbaum
0c4bc27539 Mention magma-cuda101 package in install instructions (#27325)
Summary:
There is a magma package for the newest CUDA verson (10.1), mention it here lest someone try to mistakenly use the version for CUDA 10.0.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/27325

Differential Revision: D17749535

Pulled By: soumith

fbshipit-source-id: 2d34a7af1218e6157935bfd5e03f4d2c0f00f200
2019-10-03 15:21:53 -07:00
David Pollack
66d27504e3 allow building docker without torchvision (#26168)
Summary:
There is an issue with the torchvision version not matching the pytorch version if one builds the docker from a tag, see issue https://github.com/pytorch/pytorch/issues/25917.  The current solution requires one to re-init the submodules or manually change the version of torchvision.  This PR allows one to build the docker image without torchvision, which not only fixes the above mentioned bug but also frees non-image pytorch users from the tyranny of torchvision 😆.

In all seriousness, for NLP researchers especially torchvision isn't a necessity for pytorch and all non-essential items shouldn't be in the docker.  This option removes one extra thing that can go wrong.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/26168

Differential Revision: D17550001

Pulled By: soumith

fbshipit-source-id: 48b8b9e22b75eef3afb392c618742215d3920e9d
2019-09-24 09:12:57 -07:00
Ailing Zhang
079cd4e1fc Remove requests as dependency (#26083)
Summary:
local build is slow... test in CI...
Pull Request resolved: https://github.com/pytorch/pytorch/pull/26083

Differential Revision: D17346949

Pulled By: ailzhang

fbshipit-source-id: f552d1a4be55ad4e2bd915af7c5a2c1b6667c446
2019-09-13 08:39:53 -07:00
James Reed
4d415bff2b Add requests as a legit dependency (#25596)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/25596

Giving up on trying to limit this to just a py2 dependency

Test Plan: Imported from OSS

Differential Revision: D17171063

Pulled By: jamesr66a

fbshipit-source-id: 5df35fd128f3051dd9c6709f7d45323fedc12e65
2019-09-04 17:43:37 -07:00
Hong Xu
80e2fab952 Deprecate and set a date for removing NO_* and WITH_* (user) build options (#22474)
Summary:
Currently specifying different build options in respect to the "USE_"
series is in quite a disarray. There are a lot of build options that
accept three variants: USE_OPTION, WITH_OPTION, and NO_OPTION. Some
build options only accept USE_ and NO_ variant. Some accept only USE_.
This inconsistency is quite confusing and hard to maintain.

To resolve this inconsistency, we can either let all these build options
support all three variants, or we only support the USE_ variant.

This commit makes a step to the latter choice, i.e., deprecates and sets
a date for removing the NO_ and WITH_ variants and keeps only the
USE_ variant. This is likely better than the former solution because:

- NO_ and WITH_ variants are not documented.
- CMakeLists.txt only has the USE_ variants for relevant build options
  defined. It would be a surprise that when user pass these variables to
  CMake during rebuild and find them ineffective.
- Multiple variants are difficult to maintain.
- The behavior is confusing if more than one variant is passed. For
  example, what to be expected if one sets "NO_CUDA=1 USE_CUDA=1"?

The downside is that this will break backward compatibility for existing
build scripts in the future (if they used the undocumented build
options).
Pull Request resolved: https://github.com/pytorch/pytorch/pull/22474

Differential Revision: D16149396

Pulled By: ezyang

fbshipit-source-id: 7145b88ad195db2051772b9665dd708dfcf50b7d
2019-07-08 08:22:08 -07:00
Mingzhe Li
51d0da2802 Improve build docs and process for Windows (#21190)
Summary:
Fixes #21026.
1. Improve build docs for Windows
2. Change `BUILD_SHARED_LIBS=ON` for Caffe2 local builds
3. Change to out-source builds for LibTorch and Caffe2 (transferred to #21452)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/21190

Differential Revision: D15695223

Pulled By: ezyang

fbshipit-source-id: 0ad69d7553a40fe627582c8e0dcf655f6f63bfdf
2019-06-06 13:46:52 -07:00
Hong Xu
9a989ec469 Add an option to stop the build process once cmake terminates. (#21034)
Summary:
Add an option to setup.py to stop the build process once cmake terminates. This leaves users a chance to fine adjust build options. Also update README accordingly.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/21034

Differential Revision: D15530096

Pulled By: soumith

fbshipit-source-id: 71ac6ff8483c3ee77c38d88f0d059db53a7d3901
2019-05-28 17:11:00 -07:00
PgLoLo
ec45baf4dd tensor_illustration with correct numbers and better fonts for README file (#20751)
Summary:
Fix of README tensor image for issue #20641
Numbers are fixed, symbols made more readable.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/20751

Differential Revision: D15495706

Pulled By: ezyang

fbshipit-source-id: b6013574d16253ec681fc57143efe3d53952fbe9
2019-05-24 09:18:18 -07:00
Sam Gross
6ec3c12255 Update references to minimum CUDA and cuDNN version (#20718)
Summary:
I didn't update the Windows references because I wasn't sure if they apply to CUDA 9. peterjc123 what should the Windows section say?
Pull Request resolved: https://github.com/pytorch/pytorch/pull/20718

Differential Revision: D15459276

Pulled By: colesbury

fbshipit-source-id: 917e22f8ac75378d88c962c226b5a42b6799c79a
2019-05-22 14:54:54 -07:00
David Reiss
32803b52f6 Update Conda description in PyTorch README (#20726)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/20726

Edward says it doesn't actually provide compilers,
but it does provide dependencies, so let's mention that instead.

Reviewed By: ezyang

Differential Revision: D15423316

fbshipit-source-id: 9b384f88e5bf7a3d2c132508620c276b49e1569f
2019-05-21 14:12:30 -07:00
Guanheng Zhang
0e77c0f5de Add ninja to PyTorch README.md file. (#20079)
Summary:
Fixes https://github.com/pytorch/pytorch/issues/17572
Pull Request resolved: https://github.com/pytorch/pytorch/pull/20079

Differential Revision: D15195388

Pulled By: zhangguanheng66

fbshipit-source-id: b7448b482f07e96753f727664416a5d0e85602b4
2019-05-03 07:13:51 -07:00
Amir Arsalan Soltani
792bc56ec2 Update README.md (#20088)
Summary:
Sometimes people need to checkout an older version and build PyTorch. In that case, they need to do `git submodule sync` and maybe `git submodule update --init` as mentioned [here](https://github.com/pytorch/pytorch/issues/20074).
Pull Request resolved: https://github.com/pytorch/pytorch/pull/20088

Differential Revision: D15195729

Pulled By: soumith

fbshipit-source-id: 73232b801e5524cdba462dd504fb973d95d0498c
2019-05-02 20:40:03 -07:00
davidriazati
947fd9c3f5 More doc edits (#19929)
Summary:
* document `torch.jit.Attribute`
* add JIT one-liner to `README.md`
* misc clarity edits](https://our.intern.facebook.com/intern/diff/15152418/)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/19929

Pulled By: driazati

Differential Revision: D15152418

fbshipit-source-id: dfee03f0a17300aaf453fcf17f418463288f66c2
2019-04-30 13:52:07 -07:00
huangyanhua
bacc8815c7 update Anaconda download link (#19794)
Summary:
Now `https://www.continuum.io/` is redirected to `https://www.anaconda.com` and old Anaconda download link `https://www.continuum.io/downloads` is dead. This PR update it to `https://www.anaconda.com/distribution/#download-section`.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/19794

Differential Revision: D15099538

Pulled By: soumith

fbshipit-source-id: 967dcda34d9d446c0d26c0014f10cc710f69a0c5
2019-04-26 09:45:44 -07:00
Soumith Chintala
8961ad8c5b add instructions for NVIDIA Jetson platforms (#18990)
Summary:
Thanks to dusty-nv , we now have Stable and Weekly wheels provided for the NVIDIA Jetson Platform. They require JetPack 4.2.

He's also maintaining source build instructions.

This PR adds links to the binaries and source build instructions to the README.

The links are dynamic, so when new stable / weekly wheels are available, Dustin will update the same URL to point to the new files
Pull Request resolved: https://github.com/pytorch/pytorch/pull/18990

Differential Revision: D14820158

Pulled By: soumith

fbshipit-source-id: 761a56557decb72ad9c1b9f8a2745667f558eec3
2019-04-06 12:42:43 -07:00
Gao, Xiang
1497d45315 Remove Trainer from README.md (#18980)
Summary:
Trainer has been removed long time ago
Pull Request resolved: https://github.com/pytorch/pytorch/pull/18980

Differential Revision: D14819855

Pulled By: ezyang

fbshipit-source-id: f62020e688ebf6663416aec7435bf1f531607941
2019-04-06 09:12:50 -07:00
Soumith Chintala
92c9fef860 update magma instructions (#18410)
Summary:
fixes https://github.com/pytorch/pytorch/issues/18389

cc: stas00
Pull Request resolved: https://github.com/pytorch/pytorch/pull/18410

Differential Revision: D14594198

Pulled By: soumith

fbshipit-source-id: fb46ef77a36c90ad95e47f7066f5d32aa1f1370f
2019-03-24 13:15:11 -07:00
Edward Yang
424a03186a Replace tens with hundreds.
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/17752

Differential Revision: D14366743

fbshipit-source-id: 39f6ac08180d780866e284024918d9abd197d239
2019-03-08 07:33:41 -08:00
peter
7fddd01c51 Fix the missing Windows CPU job in the build status section (#17608)
Summary:
It will be better to split the CPU job on CI. But unluckily, we are out of Windows machines.
cc, davidbrownellWork yf225
Pull Request resolved: https://github.com/pytorch/pytorch/pull/17608

Differential Revision: D14281393

Pulled By: soumith

fbshipit-source-id: ae9a6140b7207ce56cfb2da3d812bc3fe060764a
2019-03-01 10:03:25 -08:00
Soumith Chintala
7fbee1f79e update slack invite instructions
Summary: update slack invite instructions

Reviewed By: pjh5

Differential Revision: D14255348

fbshipit-source-id: 564fed0d44a6a68f80d1894fed40c3ddb360aa52
2019-02-28 11:29:05 -08:00
Evgeny Mankov
456d3e5f56 Fix errors in the description for installation on Windows (#17475)
Summary:
+ All quotes for ENV VARS are erroneous;
+ Toolset hasn't be specified;
+ Provide paths for all 3 Visual Studio 2017 products: Community/Professional/Enterprise.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/17475

Differential Revision: D14262968

Pulled By: soumith

fbshipit-source-id: c0504e0a6be9c697ead83b06b0c5cf569b5c8625
2019-02-28 10:41:16 -08:00
Mohana Rao
85ac272670 Update Docker file section in README.md (#16812)
Summary:
Emphasize on the fact that docker build should be triggered from pytorch repo directory.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/16812

Differential Revision: D13985531

Pulled By: soumith

fbshipit-source-id: c6511d1e81476eb795b37fb0ad23e8951dbca617
2019-02-06 23:53:50 -08:00
derek
8c6ff91d57 In README.md CMAKE_PREFIX_PATH should be CONDA_PREFIX when using an conda virtual environment (#15548)
Summary:
In current README.md, `CMAKE_PREFIX_PATH` is set to conda root even when you have activated an virtual environment. When an conda virtualenv is activated, packages are installed in `CONDA_PREFIX`, not conda root. I think `CMAKE_PREFIX_PATH` should also be set to `CONDA_PREFIX` in this case. I think some build issues can be solved with the new instruction. Maybe something like #14954.

soumith,
When I made PR #15335 I was confused and made a wrong point. I think this PR could be the real solution.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/15548

Differential Revision: D13549681

Pulled By: soumith

fbshipit-source-id: 42d855b6e49ee58d735d2f4715d3e5752a748693
2018-12-26 12:57:07 -08:00
Soumith Chintala
2fe5c29d81 remove legacy from docs (#15112)
Summary:
Fixes https://github.com/pytorch/pytorch/issues/15062
Pull Request resolved: https://github.com/pytorch/pytorch/pull/15112

Differential Revision: D13547845

Pulled By: soumith

fbshipit-source-id: 61e3e6c6b0f6b6b3d571bee02db2938ea9698c99
2018-12-25 21:57:54 -08:00
David Riazati
cb0b096f2b Miscellaneous small doc fixes (#15373)
Summary:
This PR makes some small changes for better consistency in our README and
CONTRIBUTING docs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/15373

Differential Revision: D13512753

Pulled By: driazati

fbshipit-source-id: 44398ad1894eef521d5f5acb1d06acaad67728cf
2018-12-20 12:33:40 -08:00
Russell Kaplan
1e93317b99 Remove "early-release beta" disclaimer from README (#15136)
Summary:
Now that PyTorch 1.0 is out, this should be updated :)
Pull Request resolved: https://github.com/pytorch/pytorch/pull/15136

Differential Revision: D13447377

Pulled By: soumith

fbshipit-source-id: bd4e662c53d0699f25d4d90c1b4c1e182b4427c2
2018-12-12 22:14:14 -08:00
Soumith Chintala
5fd69e7551 remove mingfeima mkldnn reference from README, as no longer necessary (#14975)
Summary: we now get mkldnn automatically from third_party/ideep

Differential Revision: D13396480

Pulled By: soumith

fbshipit-source-id: 20f819ba4b78cbe9c7d0baeab1c575669cbf6c20
2018-12-09 20:44:10 -08:00
Ravi Vats
da2c3afa47 Fixed typo in README.md (#14346)
Summary:
Fixed the typo in the Docker image section of README.md file
Pull Request resolved: https://github.com/pytorch/pytorch/pull/14346

Differential Revision: D13290403

Pulled By: soumith

fbshipit-source-id: 1d848027a773f0cfc875c33d69a66e96abc7ac8b
2018-12-01 16:39:33 -08:00
Freddie Mendoza
1e1dd88c4a Add Linux ppc64le CPU/GPU CI build status
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/13507

Differential Revision: D12902281

Pulled By: soumith

fbshipit-source-id: d2c89dcf08dcbe1e451ae52e85256f658155a0e1
2018-11-02 07:51:40 -07:00
Joel Marcey
ee563c5899 Add license reference to README.md
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/12822

Differential Revision: D10451895

Pulled By: JoelMarcey

fbshipit-source-id: dee4cafd3120571e52cf242bb0674c7aa7dab217
2018-10-18 14:10:24 -07:00
Marcela Morales Quispe
d4b4c1fbec Add missing url links to README.md file. (#12440)
Summary:
Signed-off-by: Marcela Morales Quispe <marcela.morales.quispe@gmail.com>
Pull Request resolved: https://github.com/pytorch/pytorch/pull/12440

Differential Revision: D10242642

Pulled By: SsnL

fbshipit-source-id: f47d7579cf3df097c476a97b58149ca4b1eb17ab
2018-10-08 13:54:21 -07:00
Marcela Morales Quispe
8689d8af36 Format inline code block. (#12441)
Summary:
Signed-off-by: Marcela Morales Quispe <marcela.morales.quispe@gmail.com>
Pull Request resolved: https://github.com/pytorch/pytorch/pull/12441

Differential Revision: D10236743

Pulled By: SsnL

fbshipit-source-id: c0e446a81a388cf6a558bf7ab8ba0e59703dc169
2018-10-08 00:51:07 -07:00
Ir1dXD
b911ca9b0d docs: change links to https (#12258)
Summary:
Hi, I think it might be better to use https instead of http in the README.md.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/12258

Differential Revision: D10162279

Pulled By: soumith

fbshipit-source-id: 4658aa75175909b4fea6972b437765d8b49c749f
2018-10-03 06:33:09 -07:00
John
86e025fca2 magma-cuda should reference updated versions (#12000)
Summary:
Source build doc section **LAPACK GPU**  only lists magma-cuda80

The magma-cuda version should reflect the installed version of cuda.

- Verified on ubuntu with magma-cuda92 with build and test
- Verified 91 is available
Pull Request resolved: https://github.com/pytorch/pytorch/pull/12000

Differential Revision: D10024158

Pulled By: soumith

fbshipit-source-id: a34c85a5e87b52657f1e6f7b21d235306ab7b2aa
2018-09-24 20:26:26 -07:00
peter
a7afd133f5 Sync FindCUDA.cmake with upstream cmake repo (#11880)
Summary:
Upstream PR: https://gitlab.kitware.com/cmake/cmake/merge_requests/2391/diffs
Pull Request resolved: https://github.com/pytorch/pytorch/pull/11880

Differential Revision: D9989119

Pulled By: soumith

fbshipit-source-id: 66e87367127975a5f1619fe447f74e76f101b503
2018-09-21 06:58:17 -07:00
Soumith Chintala
87701289a3 fix link to previous versions (#11894)
Summary:
https://github.com/pytorch/pytorch.github.io/issues/68#issuecomment-423073108
Pull Request resolved: https://github.com/pytorch/pytorch/pull/11894

Differential Revision: D9973695

Pulled By: soumith

fbshipit-source-id: 1f74b12487ec39f4e88b527dcdfca0742e689c15
2018-09-20 11:10:37 -07:00
peter
10c29c8970 Fix CUDA 8 build on Windows (#11729)
Summary:
Tested via https://github.com/pytorch/pytorch/pull/11374.
Upstream PR: https://gitlab.kitware.com/cmake/cmake/merge_requests/2391
Pull Request resolved: https://github.com/pytorch/pytorch/pull/11729

Differential Revision: D9847807

Pulled By: orionr

fbshipit-source-id: 69af3e6c5bba0abcbc8830495e867a0b1b399c22
2018-09-16 08:09:24 -07:00
Rasmus Diederichsen
8aa8ad8b01 WIP: Reproducibility note (#11329)
Summary:
This adds a Note on making experiments reproducible.

It also adds Instructions for building the Documentation to `README.md`. Please ping if I missed any requirements.

I'm not sure what to do about the submodule changes. Please advise.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/11329

Differential Revision: D9784939

Pulled By: ezyang

fbshipit-source-id: 5c5acbe343d1fffb15bdcb84c6d8d925c2ffcc5e
2018-09-11 21:09:51 -07:00
Edward Yang
de099564e3 Minor copy-edit on README
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/10931

Reviewed By: cpuhrsch

Differential Revision: D9526248

fbshipit-source-id: 2401a0c1cd8c5e680c6d2b885298fa067d08f2c3
2018-08-27 21:09:36 -07:00
LadyRick
3a40baa15c fix a grammatical error: accelerate compute (#10204)
Summary:
"accelerate compute"
a verb shouldn't go with another verb.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/10204

Differential Revision: D9316699

Pulled By: fmassa

fbshipit-source-id: f1126c594905c3236ffd6b7e57a92552d3d4c1f1
2018-08-14 10:11:15 -07:00
Thiago Crepaldi
7d6d7bef6a Enable docker image build for PyTorch using specific python version (#10317)
Summary:
Current Dockerfile builds pytorch using default python within miniconda, which happens to be Python 3.6

This patch allows users to specify which python should be installed in the default miniconda environment used by the pytorch dockerfile. I have tested the build for python 2.7, 3.5, 3.6 and 3.7. Python 2.7 required typing and cython
Pull Request resolved: https://github.com/pytorch/pytorch/pull/10317

Differential Revision: D9204401

Pulled By: ezyang

fbshipit-source-id: 11355cab3bf448bbe8369a2ed1de0d409c9a2d6e
2018-08-07 16:13:33 -07:00
peter
506142ac8a Add warning for building PyTorch using Python 2.7 on Windows (#10247)
Summary:
Fixes #9232.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/10247

Differential Revision: D9178257

Pulled By: SsnL

fbshipit-source-id: cc553335a5a918b6d77fe1064460cb66114859ca
2018-08-05 21:24:02 -07:00
caoxudong
a74a3fdeb6 typo fix, tutorials url with http protocol is not valid (#9812)
Summary:
The tutorials url with http is not valid, replacing it with https.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/9812

Differential Revision: D8991344

Pulled By: ezyang

fbshipit-source-id: c12faa57905b50eadc320f9938c39c4139bd093b
2018-07-25 07:54:26 -07:00
Thiago Crepaldi
11fc16dc98 Remove HTML tags from README.md (#9296)
Summary:
This change makes README.md compatible with both Github and VSTS markdown engines. Images can be reduced if necessary
Pull Request resolved: https://github.com/pytorch/pytorch/pull/9296

Differential Revision: D8874931

Pulled By: soumith

fbshipit-source-id: 0c530c1e00b06fc891301644c92c33007060bf27
2018-07-17 07:24:43 -07:00
peter
19ecb5f8ad Fix docs for Windows CUDA 8 builds (#9254)
Summary:
Fixes #9200.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/9254

Differential Revision: D8778011

Pulled By: soumith

fbshipit-source-id: 0a2c2863ac1bc515397fc446039db64d1d4e236d
2018-07-09 18:55:03 -07:00
Edward Yang
c82715ced5 Add some extra punctuation to README. (#8941)
Summary:
Signed-off-by: Edward Z. Yang <ezyang@fb.com>
Closes https://github.com/pytorch/pytorch/pull/8941

Differential Revision: D8661797

Pulled By: ezyang

fbshipit-source-id: 876163b11a8463d7560308b2b8e68231f2a657cb
2018-06-27 08:56:13 -07:00
Peter Goldsborough
98a7d84a5a Link to C++ extensions in README.md (#8737) 2018-06-21 09:48:04 -04:00
Edward Z. Yang
dbe5c7f6e9
Mention the pytorch-ci-hud on the README. (#8004)
Signed-off-by: Edward Z. Yang <ezyang@fb.com>
2018-06-01 06:56:48 -04:00
cpuhrsch
6e1de968d6 Use mingfeima's mkldnn (#7977) 2018-05-30 21:46:39 -04:00
Soumith Chintala
1ce7ed2895
fix slack email link 2018-05-29 15:51:22 -04:00
cpuhrsch
330a72581f Update README to contain instructions on how to install mkldnn for Linux (#7625) 2018-05-16 19:08:03 -04:00
Richard Zou
4d0097fab8 Note that the Docker Hub image is not up-to-date. (#6434)
Fixes #6397.
2018-04-16 14:31:34 -04:00
peterjc123
f54eac7eba Add flag and warning for Python 2.7 users on Windows (#6499) 2018-04-11 23:06:51 -04:00
peterjc123
5651695a99 Fixes #6386, Use copies instead of symbolic files (#6396)
* Use copies instead of symbolic files

* bug fix

* Remove useless item
2018-04-09 13:54:10 -04:00
Richard Zou
7355f5cd8d Tell source users about TORCH_CUDA_ARCH_LIST (#6185)
Put it into the comments about env vars in setup.py.
Also put in a line in the README about where to find this info.
2018-04-02 13:35:14 -04:00
Russ Ferriday
8054dbd655 Trivial typo (#6053) 2018-03-27 14:21:47 -07:00
Edward Z. Yang
b5fa9a82c8 Update Dockerfile build instructions for new layout. (#6051)
Signed-off-by: Edward Z. Yang <ezyang@fb.com>
2018-03-27 14:11:22 -07:00
JP
2df578a71a add mkl dependencies to setup (#5991) 2018-03-25 23:21:16 -04:00
peterjc123
332d5ffd11 Modidy setup docs for Windows (#5981) 2018-03-24 12:17:01 -04:00
peterjc123
03495137d0 Add windows doc (#5859) 2018-03-23 11:54:44 -04:00
Tongzhou Wang
22ef8e5654 [fft][1 of 3] build system and helpers to support cuFFT and MKL (#5855)
This is the first of three PRs that #5537 will be split into.

This PR adds mkl headers to included files, and provides helper functions for MKL fft and cuFFT.
In particular, on POSIX, headers are using mkl-include from conda, and on Windows, it is from a new file @yf225 and I made and uploaded to s3.

* add mkl-include to required packages

* include MKL headers; add AT_MKL_ENABLED flag; add a method to query MKL availability

* Add MKL and CUFFT helpers
2018-03-19 15:43:14 -04:00
Clinton Yeboah
1ff36bfd61 Missed Step (#5558)
I think you missed a step
2018-03-05 08:59:48 -05:00
Roger Pack
bc4c919a9e update dependencies (#5423)
On OS X from source I get    `Missing build dependency: Unable to import the typing module. `
2018-02-26 22:43:42 -05:00
Richard Zou
dcbbf346c2 Change output_declarations in function_wrapper.py to be a NamedTuple (#5312)
* Add python typing module as build dependency

* Change output_declarations to be a NamedTuple

* Add mypy configuration files

mypy-files.txt includes a list of all files that should be typed checked
with mypy. Run mypy with `mypy @mypyfiles.txt`.

mypy.ini includes mypy options. Unfortunately this can't be merged with
mypy-files.txt.

Update .travis.yml so that one doesn't have to specify what files to
type check inside it.

* Add RuntimeError on missing `typing` module

Alerts users to the new build dependency.
2018-02-23 13:33:59 -05:00
Sean Naren
fe810edc80 Consolidated dockerfile changes, updated README (#5235) 2018-02-14 11:57:23 -05:00
Soumith Chintala
db45dbbebf
Update README.md 2018-01-22 15:16:48 -05:00
Adam Paszke
2e279eb260 Make the dash nicer 2018-01-04 13:51:01 +01:00
Adam Paszke
a246d56150 Update build matrix badges in the README 2018-01-04 13:48:29 +01:00
Scott Stevenson
a9ef76b9c6 Reflect renaming of OS X to macOS (#3795) 2017-11-20 16:52:10 -05:00
Richard Zou
dc10083fc0 Previous PyTorch version info (#3549) 2017-11-07 17:15:33 -05:00
Victoria X Lin
d2ddbaaf8d Fix command highlight in README (#3521) 2017-11-07 06:50:48 -05:00
ngimel
dfaccc96b7 add dockerfile with cuda9 volta support (#3445) 2017-11-02 15:08:39 -04:00
Frank Cash
7b5ac333ad Update README.md (#3392)
Getting started HyperLinks match up now.
2017-10-31 10:48:33 -04:00
Sebastian Raschka
f176c864f0 minor autograd reference change in readme (#3144) 2017-10-17 10:16:06 +02:00
Richard Zou
8666be05f5 Raise runtime error in setup.py if cudnn version is not supported 2017-10-13 23:58:25 +02:00
soumith
f74665f0c4 remove gcc install suggestion 2017-10-10 14:45:19 -07:00
Soumith Chintala
d84dbcfb9e add a "clone the source" section 2017-08-31 11:55:23 -04:00
Soumith Chintala
a655e6313e update README with new major contributors and remove redundant sections 2017-08-25 13:47:17 -04:00
Alykhan Tejani
de24bb4b66 Update readme with docker cmd (#2501)
* update docker command in readme to use pre-built images

* correct spelling of Docker Hub

* Update README.md
2017-08-21 08:52:26 -04:00
Soumith Chintala
d2b8d3f8f7 add slack clarification 2017-08-21 06:12:46 -04:00
Gavin
bf1fc250d1 get conda root dir automatically, trick from Dockerfile 2017-07-20 11:02:30 -04:00
Valentin Haenel
03f41c8120 fix capitalization of Python, make it consistent 2017-06-21 00:09:37 +02:00
Matt
a9bd1de9e9 fixed README to reflect docker image name (#1751) 2017-06-07 15:49:39 -04:00
ngimel
e3305eb9dc Runtime dockerfile (#1732)
* reduce the size of Docker image

* add runtime dockerfile
2017-06-05 17:40:06 -04:00
Jimmy Jia
ec2de16776 Improve README copyediting 2017-06-02 21:02:14 +02:00
Adam Paszke
0c5598c668 Update build status matrix 2017-05-21 12:20:50 +02:00
Soumith Chintala
c7d83a16f6 Update README.md 2017-04-18 19:05:18 -04:00
Evan Klitzke
e21e4bf3e8 add pyyaml to conda note here as well 2017-04-11 21:21:18 -07:00
Soumith Chintala
7c59754d24 update source build instructions 2017-04-11 15:24:31 -07:00
Evan Klitzke
ade105fb7c update README to install pyyaml from conda (#1231) 2017-04-11 10:23:45 -07:00
Soumith Chintala
bc0ed9298d remove incorrect version in readme 2017-04-09 14:44:44 -04:00
Vincenzo Ferrari
64ee4056d7 updated docker image inside the docs (#1216) 2017-04-08 10:29:03 -04:00
ngimel
215813d7ac Change dockerfile to support for cudnn v6 (#1135) 2017-03-28 20:05:04 -04:00
Du Phan
dc7695a47a Update links for tutorials in README (#1123) 2017-03-28 14:21:40 +02:00
Michael Galkov
d25433a099 Fix docker build commands (#1103) 2017-03-25 16:18:33 -04:00
Soumith Chintala
b25182971f readme change for getting clarity on binaries 2017-02-26 07:52:13 -05:00
Edgar Riba
6073f9b46c update table in README.md
it removes the empty top row
2017-02-21 12:58:04 -05:00
L. Zhou
a1bd4efb08 readme: add guidance on disabling CUDA (#655) 2017-01-31 14:05:51 +05:30
Luke Yeager
31dea5ff23 Small typo in README (#613) 2017-01-27 20:18:36 +01:00
ngimel
3c2ecc6b15 add dockerfiles (#583)
* add dockerfiles
2017-01-25 17:30:29 -05:00
Luke Yeager
aa46055274 Update CI links in README (#579) 2017-01-25 13:58:05 -05:00
Soumith Chintala
ce13900148 update From Source instructions 2017-01-24 10:48:25 -05:00
Soumith Chintala
30ec12fdd5 update readme for source installs to make magma dependency optional 2017-01-19 16:20:13 -05:00
Soumith Chintala
269ec0566f fix typo 2017-01-19 14:26:50 -05:00
Yunfeng Wang
f2741e8038 format fix (#490) 2017-01-18 21:41:10 -05:00
Soumith Chintala
784cbeff5b added a non-exhaustive list of contributors 2017-01-18 13:54:56 -05:00
Soumith Chintala
798fc16bbf add beta tag 2017-01-18 12:21:46 -05:00
Soumith Chintala
279aea683b update conda install command 2017-01-18 10:52:49 -05:00
Soumith Chintala
89cab4f5e6 fix readme language and links 2017-01-16 20:35:08 -05:00
Soumith Chintala
a0afb79898 add pic to readme 2017-01-16 20:15:19 -05:00
Adam Paszke
3b6644d195 Minor README fix 2017-01-17 00:15:06 +01:00
Soumith Chintala
652b468ec2 Readme improvements 2017-01-16 18:05:26 -05:00
Soumith Chintala
af110d37f2 remove old docs 2017-01-16 15:06:08 -05:00
Soumith Chintala
133c1e927f fix readme, bump version 2017-01-14 17:47:35 -05:00
Soumith Chintala
0f04f71b7e fix API reference link 2017-01-05 02:46:19 -05:00
Soumith Chintala
ec987b57f6 removing 3.3, 3.4 from README badges 2016-12-26 14:52:36 -05:00
Soumith Chintala
230bde94e7 fix about section 2016-12-19 11:00:53 -05:00
Soumith Chintala
4e2b154342 update install command from source 2016-12-01 10:55:04 +01:00
Soumith Chintala
073dfd8b88 bump version 2016-11-18 12:26:12 -05:00
Soumith Chintala
56dd4132c4 add MACOSX_DEPLOYMENT_TARGET to instructions 2016-11-16 10:45:56 -05:00
soumith
4b7f8f9b77 adding notes for compiling from source 2016-11-01 01:27:28 -04:00
Soumith Chintala
3d8eba7b42 updating readme with new info 2016-10-02 10:13:15 -07:00
Soumith Chintala
b5f7720ab9 docstrings for container and batchnorm 2016-09-16 05:31:36 -04:00