Skip to content

Commit

Permalink
Add installation instructions for GPU
Browse files Browse the repository at this point in the history
  • Loading branch information
emnigma committed Jan 18, 2024
1 parent 9d7cbd2 commit 113398f
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,9 @@
Python infrastructure to train paths selectors for symbolic execution engines.


## Launch guide
## Installation and usage

Firstly, follow the steps in [Environment setup](#environment-setup) to create virtual environment

...

## Contribution

Here's a quick guide to start contributing:

### Environment setup
### Installation

In repository root run:
```bash
Expand All @@ -22,11 +14,20 @@ source .env/bin/activate
pip install requirements.txt
```

### Linting
#### GPU installation:

To use GPU, the correct `torch` and `torch_geometric` version should be installed depending on your host device. You may first need to `pip uninstall` these packages, provided by requirements.
Then follow installation instructions provided on [torch](https://pytorch.org/get-started/locally/) and [torch_geometric](https://pytorch-geometric.readthedocs.io/en/stable/install/installation.html#installation-from-wheels) websites.

Install black formatter by running this command in repo root
### Usage

...

### Linting tools

Install [black](https://github.com/psf/black) code formatter by running following command in repo root to check your codestyle before committing:
```bash
pip install pre-commit && pre-commit install
```
to check your codestyle on pre-commit


0 comments on commit 113398f

Please sign in to comment.