Skip to content

Commit a847328

Browse files
Update instructions and resources
1 parent 65b8c55 commit a847328

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,24 @@ To classify your own images, you can use the live API: use the link [here](https
1515
TBD
1616

1717
### Running Locally
18+
19+
#### Using Docker
1820
You can download this repository and run it using [Docker](https://www.docker.com/get-started):
1921

2022
```docker compose up```
2123

22-
Alternatively, you can also make a virtual environment and run it using the `uvicorn` package:
24+
#### Using Virtual Environments
25+
26+
Alternatively, you can also make a virtual environment and install the dependencies locally:
2327

2428
```
25-
$ python3 -m venv env # creates a virtualenv
26-
$ source env/bin/activate # now you're in the virtualenv
27-
$ uvicorn app.main:app --reload # run the app
29+
$ python3 -m venv env
30+
$ source env/bin/activate
31+
(env) $ python -m pip install -r requirements.txt
32+
```
33+
And then run the app using `uvicorn` in the Command Line:
34+
```
35+
(env) $ uvicorn app.main:app --reload
2836
```
2937

3038
## The Data and the Model
@@ -47,3 +55,4 @@ In this project, we've worked with different tools like Tensorflow, Docker, Fast
4755
## Credits and Resources
4856
1. This *Towards Data Science* [blog](https://towardsdatascience.com/a-step-by-step-tutorial-to-build-and-deploy-an-image-classification-api-95fa449f0f6a) by Youness Mansar will give you a little more detail on how you can build a deployment-driven deep learning project (using the Google Cloud Platform's App Engine).
4957
2. Another [blog](https://towardsdatascience.com/how-to-deploy-your-fastapi-app-on-heroku-for-free-8d4271a4ab9#beb1) by Shinichi Okada in *Towards Data Science* will give more details how to deploy FastAPI applications (such as this repo!) on Heroku specifically.
58+
3. If you're curious to know why we used `python -m pip` in the [Using Virtual Environments](#using-virtual-environments) section, please read this [explanation](https://snarky.ca/why-you-should-use-python-m-pip/) to see how it differs from just using `pip`/`pip3`.

0 commit comments

Comments
 (0)