https://github.com/kmcleste/dsba-6156

A neural search engine. Designed and produced for DSBA 6156: Applied Machine Learning.
https://github.com/kmcleste/dsba-6156

docker faiss fastapi machine-learning neural-search-engine python streamlit

Last synced: 3 months ago
JSON representation

A neural search engine. Designed and produced for DSBA 6156: Applied Machine Learning.

• Host: GitHub
• URL: https://github.com/kmcleste/dsba-6156
• Owner: kmcleste
• License: gpl-3.0
• Created: 2022-10-09T20:21:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-16T20:17:41.000Z (about 2 years ago)
• Last Synced: 2024-10-17T03:38:55.387Z (4 months ago)
• Topics: docker, faiss, fastapi, machine-learning, neural-search-engine, python, streamlit
• Language: Python
• Homepage:
• Size: 3.44 MB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# DSBA 6156: Applied Machine Learning

![](https://img.shields.io/github/last-commit/kmcleste/dsba-6156)

Shared repository for Applied Machine Learning Group 2 Final Project.

## Getting Started

Make sure to read through our [Contribution Guidelines](https://github.com/kmcleste/dsba-6156/blob/main/CONTRIBUTING.md) for instructions on environment setup and creating your first commit.

## Usage

Below are instructions for running the project locally and within a [Docker](https://www.docker.com/) container.

### Local

To start the FastAPI service, run the following from the base directory of the repo:

```bash

make fastapi

```

Once the service has finished initializing, you can head on over to [127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) to view the interactive Swagger documentation.

![Swagger Documentation](images/swagger_example.png)

To start the Streamlit service, open another terminal and run:

```bash

make streamlit

```

![Streamlit Home Page](images/streamlit_home.png)

Once the Streamlit service has started, you can view the web app by going to [127.0.0.1:8501](http://127.0.0.1:8501) in your browser.

### Docker

To start the services in Docker, run the following:

```bash

docker-compose up

```

Once the services have finished initializing, you can head on over to [127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) and [127.0.0.1:8501](http://127.0.0.1:8501) to view the Swagger documentation and Streamlit app, respectively.

To build the images locally, run:

```bash

# build both images

make docker-build

# build individually

make docker-build-ui

make docker-build-api

# build using docker compose

docker-compose -f docker-compose-dev.yml build

# build and run

docker-compose -f docker-compose-dev.yml up --build

```

## License

[MIT](https://choosealicense.com/licenses/mit/)