Skip to content

Commit

Permalink
Update README.md (facebookresearch#217)
Browse files Browse the repository at this point in the history
Summary:
Remove pip package install instructions and fix instructions related to GPU / INSTALL_CPP

## Types of changes

- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Motivation and Context / Related issue

## How Has This Been Tested (if it applies)

## Checklist

- [ ] The documentation is up-to-date with the changes I made.
- [ ] I have read the **CONTRIBUTING** document and completed the CLA (see **CONTRIBUTING**).
- [ ] All tests passed, and additional code has been covered with new tests.

Pull Request resolved: facebookresearch#217

Reviewed By: lw

Differential Revision: D29231442

Pulled By: adamlerer

fbshipit-source-id: db1a4e6424e6d6adfa538e3dee2e6a60962b5eaa
  • Loading branch information
adamlerer authored and facebook-github-bot committed Jun 21, 2021
1 parent 980a88b commit e76138a
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,7 @@ When running on multiple machines, they need to be able to communicate to each o

## Installation

To install the latest version of PBG run:
```bash
pip install torchbiggraph
```

As an alternative, one can instead install the *development* version from the repository. This may have newer features but could be more unstable. To do so, clone the repository (or download it as an archive) and, inside the top-level directory, run:
Clone the repository (or download it as an archive) and, inside the top-level directory, run:
```bash
pip install .
```
Expand All @@ -49,7 +44,7 @@ PyTorch-BigGraph includes some C++ kernels that are only used for the experiment
PBG_INSTALL_CPP=1 pip install .
```

Everything will work identically except that you won't be able to run GPU training (`torchbiggraph_train_gpu`).
Everything will work identically except that you will be able to run GPU training (`torchbiggraph_train_gpu`).


## Getting started
Expand Down

0 comments on commit e76138a

Please sign in to comment.