Skip to content

docs: improve README #3

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
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #3

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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# eCLIP

<a href="https://arxiv.org/abs/2403.10153">
Expand All @@ -13,6 +15,8 @@ Read the full paper here: https://arxiv.org/abs/2403.10153

### Setup

The repository requires Python >= 3.11.

We use the `eclip` package for training and evaluation. To install it run `pip install -e .` from the root folder and it installs all the dependencies.

We use `pytorch-lightning` to train the model and `hydra` to handle the config files.
Expand Down Expand Up @@ -65,4 +69,3 @@ We use `Mistral 7B Instruction` for generating radiology reports using the input
- Tracking -- [Weights & Biases](https://wandb.ai/)
- Config Management -- [Hydra](https://hydra.cc/)
- Data loading -- [Webdataset](https://github.com/webdataset/webdataset)