Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,22 @@
* See our [list of supported tasks](./guides/tasks/supported_tasks.md)

## Installation
To install `jiant`:
```
git clone https://github.com/nyu-mll/jiant.git

python3 -m venv venv
source venv/bin/activate
To import `jiant` from source (recommended for researchers):
```bash
git clone https://github.com/nyu-mll/jiant.git
cd jiant
pip install -r requirements.txt

# Add the following to your .bash_rc or .bash_profile
export PYTHONPATH=/path/to/jiant:$PYTHONPATH
```


If you plan to contribute to jiant, install additional dependencies with `pip install -r requirements-dev.txt`.

We recommended that you install `jiant` in a virtual environment or a conda environment.

To check `jiant` was correctly installed, run a [simple example](./examples/notebooks/simple_api_fine_tuning.ipynb).


Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@
keywords="NLP deep learning transformer pytorch tensorflow BERT GPT GPT-2 google nyu datasets",
license="MIT",
url="https://github.com/nyu-mll/jiant",
package_dir={"": "jiant"},
packages=find_packages("jiant"),
packages=find_packages(exclude=["tests", "tests/*"]),
install_requires=[
"attrs == 19.3.0",
"bs4 == 0.0.1",
Expand Down