Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated CONTRIBUTING.md for setup of venv and standard pip install #127

Merged
merged 3 commits into from
Apr 21, 2022
Merged

Updated CONTRIBUTING.md for setup of venv and standard pip install #127

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b18369d
Updated CONTRIBUTING.md for setup of venv and standard pip install
adhadse Apr 16, 2022
c91733b
Updated CONTRIBUTING.md with proposed changes
adhadse Apr 19, 2022
74e3b0c
Fixes
mattdangerw Apr 21, 2022
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: 11 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,24 @@ Once the pull request is approved, a team member will take care of merging.
## Setup environment

Setting up your KerasNLP development environment requires you to fork the
KerasNLP repository, clone the repository, install dependencies, and execute
`python setup.py develop`.
KerasNLP repository, clone the repository, create a virtual environment, and install dependencies.
adhadse marked this conversation as resolved.
Show resolved Hide resolved

You can achieve this by running the following commands:

```shell
gh repo fork keras-team/keras-nlp --clone --remote
cd keras-nlp

(on Windows)
adhadse marked this conversation as resolved.
Show resolved Hide resolved
python -m venv ./venv
venv/Scripts/activate

(on Debian)
sudo apt install python3.8-venv
adhadse marked this conversation as resolved.
Show resolved Hide resolved
python -m venv ./venv
adhadse marked this conversation as resolved.
Show resolved Hide resolved
source venv/bin/activate

pip install ".[tests]"
adhadse marked this conversation as resolved.
Show resolved Hide resolved
python setup.py develop
```

The first line relies on having an installation of [the GitHub CLI](https://github.com/cli/cli).
adhadse marked this conversation as resolved.
Show resolved Hide resolved
Expand Down