Skip to content

Added Installation to README #176

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

Open
JakeKantor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added Installation to README #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,41 @@ About the name:
* pytorch >= 1.1.0
* torchvision >= 0.3.0

# Installation Instructions

## 1. Clone the Repository

```bash
git clone https://github.com/your-username/FaceX-Zoo.git
cd FaceX-Zoo
```

## 2. Set Up Virtual Environment

```bash
python -m venv face-env
```

Activate on Linux/MacOS:
```bash
source face-env/bin/activate
```

Activate on Windows:
```bash
face-env\Scripts\activate
```
## 3. Install Dependencies
```bash
pip install -r requirements.txt
```
## 4. Check Installation
```bash
python -c "import facex_zoo"
```



# Model Training
See [README.md](training_mode/README.md) in [training_mode](training_mode), currently support conventional training and [semi-siamese training](https://arxiv.org/abs/2007.08398).
# Model Evaluation
Expand Down