{"id":16135396,"url":"https://github.com/kmcleste/dsba-6156","last_synced_at":"2025-04-17T03:41:37.856Z","repository":{"id":63534732,"uuid":"548560216","full_name":"kmcleste/dsba-6156","owner":"kmcleste","description":"A neural search engine. Designed and produced for DSBA 6156: Applied Machine Learning.","archived":false,"fork":false,"pushed_at":"2022-12-16T20:17:41.000Z","size":3603,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T05:51:18.230Z","etag":null,"topics":["docker","faiss","fastapi","machine-learning","neural-search-engine","python","streamlit"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kmcleste.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-09T20:21:25.000Z","updated_at":"2024-09-18T02:35:01.000Z","dependencies_parsed_at":"2023-01-29T16:00:58.198Z","dependency_job_id":null,"html_url":"https://github.com/kmcleste/dsba-6156","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmcleste%2Fdsba-6156","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmcleste%2Fdsba-6156/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmcleste%2Fdsba-6156/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmcleste%2Fdsba-6156/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kmcleste","download_url":"https://codeload.github.com/kmcleste/dsba-6156/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249310547,"owners_count":21249078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","faiss","fastapi","machine-learning","neural-search-engine","python","streamlit"],"created_at":"2024-10-09T23:07:39.336Z","updated_at":"2025-04-17T03:41:37.820Z","avatar_url":"https://github.com/kmcleste.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DSBA 6156: Applied Machine Learning\n\n![](https://img.shields.io/github/last-commit/kmcleste/dsba-6156)\n\nShared repository for Applied Machine Learning Group 2 Final Project.\n\n## Getting Started\n\nMake 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.\n\n## Usage\n\nBelow are instructions for running the project locally and within a [Docker](https://www.docker.com/) container.\n\n### Local\n\nTo start the FastAPI service, run the following from the base directory of the repo:\n\n```bash\nmake fastapi\n```\n\nOnce 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.\n\n![Swagger Documentation](images/swagger_example.png)\n\nTo start the Streamlit service, open another terminal and run:\n\n```bash\nmake streamlit\n```\n\n![Streamlit Home Page](images/streamlit_home.png)\n\nOnce 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.\n\n### Docker\n\nTo start the services in Docker, run the following:\n\n```bash\ndocker-compose up\n```\n\nOnce 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.\n\nTo build the images locally, run:\n\n```bash\n# build both images\nmake docker-build\n\n# build individually\nmake docker-build-ui\nmake docker-build-api\n\n# build using docker compose\ndocker-compose -f docker-compose-dev.yml build\n\n# build and run\ndocker-compose -f docker-compose-dev.yml up --build\n```\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmcleste%2Fdsba-6156","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkmcleste%2Fdsba-6156","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmcleste%2Fdsba-6156/lists"}