Skip to content

Commit

Permalink
updated readme with virtual env instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
drustanyjt committed Jul 9, 2023
1 parent d7fb9fb commit ca75b3a
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 27 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,6 @@ datasets/vindr-cxr-original/train

vision-docker/vision
vision-docker/segmented/*.png
segments/
segments/

*.Identifier
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,34 @@ The AI behind Charlie X

## Setup

### pip

You will required python installed. There are multiple environment files,
but for most cases it suffices to use `vision-docker/requirements.txt`.

First create a virutal environment (we'll call ours vision) and activate it:

```bash
python3 -m venv vision
source ./vision/bin/activate
```

You should see your prompt be prefixed with the name of the environment (vision).

Next install all the required packages:

```bash
pip install -r vision-docker/requirements.txt
```

And that should be all.

### conda

conda is another way to manage environments. However many of their dependencies have problems so it might be difficult to use.

The instructions below have worked so far.

To start working on this repository, you will need to have miniconda/ anaconda installed,
I recommend installing miniconda.

Expand Down
41 changes: 16 additions & 25 deletions autoencoder.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion vision-docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ RUN pip install -r requirements.txt

COPY . .

CMD ["uvicorn", "app:app", "--host=0.0.0.0", "--port=8080"]
CMD "uvicorn app:app --host=0.0.0.0 --port=8080"

0 comments on commit ca75b3a

Please sign in to comment.