generated from VectorInstitute/aieng-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,10 @@ | ||
# AI Engineering template | ||
|
||
---------------------------------------------------------------------------------------- | ||
|
||
[![code checks](https://github.com/VectorInstitute/aieng-template/actions/workflows/code_checks.yml/badge.svg)](https://github.com/VectorInstitute/aieng-template/actions/workflows/code_checks.yml) | ||
[![integration tests](https://github.com/VectorInstitute/aieng-template/actions/workflows/integration_tests.yml/badge.svg)](https://github.com/VectorInstitute/aieng-template/actions/workflows/integration_tests.yml) | ||
[![docs](https://github.com/VectorInstitute/aieng-template/actions/workflows/docs_deploy.yml/badge.svg)](https://github.com/VectorInstitute/aieng-template/actions/workflows/docs_deploy.yml) | ||
[![codecov](https://codecov.io/gh/VectorInstitute/aieng-template/branch/main/graph/badge.svg)](https://codecov.io/gh/VectorInstitute/aieng-template) | ||
[![license](https://img.shields.io/github/license/VectorInstitute/aieng-template.svg)](https://github.com/VectorInstitute/aieng-template/blob/main/LICENSE.md) | ||
|
||
A template repo for AI Engineering projects (using ``python``) | ||
|
||
## 🧑🏿💻 Developing | ||
|
||
### Installing dependencies | ||
|
||
The development environment can be set up using | ||
[poetry](https://python-poetry.org/docs/#installation). Hence, make sure it is | ||
installed and then run: | ||
## Introduction | ||
This repository consists of scripts for the paper [Can Machine Unlearning Reduce Social Bias in Language Models?](https://openreview.net/pdf?id=UBX8SCj6rK) [To be published to EMNLP 2024 Industry Track]. | ||
|
||
## Running scripts | ||
1. Install required packages: | ||
```bash | ||
python3 -m poetry install | ||
source $(poetry env info --path)/bin/activate | ||
python -m pip install -r requirements.txt | ||
``` | ||
|
||
In order to install dependencies for testing (codestyle, unit tests, integration tests), | ||
run: | ||
|
||
```bash | ||
python3 -m poetry install --with test | ||
``` | ||
2. Instructions for running scripts are available in the respective directories for each method. |