Skip to content

Update readme to use the standard #359

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

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Update readme to use the standard #359

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02bf34e
Update readme to use the standard
shoumikhin Apr 21, 2024
b5995b4
Merge branch 'main' into main
shoumikhin Apr 22, 2024
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
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,19 @@ Torchchat is an easy-to-use library for running large language models (LLMs) on

## Quick Start
### Initialize the Environment
The following steps requires you have [Python 3.10](https://www.python.org/downloads/release/python-3100/) and [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) installed
The following steps requires you have [Python 3.10](https://www.python.org/downloads/release/python-3100/) installed

```
# set up a virtual environment
python3 -m virtualenv .venv/torchchat
source .venv/torchchat/bin/activate

# get the code and dependencies
# get the code
git clone https://github.com/pytorch/torchchat.git
cd torchchat
bash ./install_requirements.sh

# set up a virtual environment
python3 -m venv .venv
source .venv/bin/activate

# instal dependencies
./install_requirements.sh

# ensure everything installed correctly
python torchchat.py --help
Expand Down