Scylidose / AtlasFind

An answer-based search engine that delivers concise results about No Man's Sky related questions.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AtlasFind

This project is an answer-based search engine that fetches and answers user questions based on content from the No Man's Sky Wiki fandom page. The search engine is designed to provide quick and accurate answers to questions related to the game, such as information on planets, star systems, resources, creatures, and more.

web app django

Streamlit integration

A streamlit integration was added to enable easy and shareable web app.

web app streamlit

How does it work

My application crawls the https://nomanssky.fandom.com/ website, extracting numerous pages that are subsequently stored in an SQL database. The project employs the Whoosh search application to enable users to search through these stored documents using queries. The retrieved documents are then processed by one of three language models: DeepPavlov, GPT-3.5 (4k tokens), or GPT-3.5 (16k tokens) to generate responses for users.

explanation graph

(generated by instagraph)

Getting Started

Prerequisites

To run this project, you will need:

  • Python (version 3.8.0 or higher)
  • Django (version 3.0 or highter)
  • The text stored in the No Man's Sky Wiki fandom website

Installation and Setup

  1. Clone this repository to your local machine.
git clone https://github.com/Scylidose/AtlasFind.git
  1. Create and activate a new virtual environment:
python3 -m venv venv
source venv/bin/activate # on Linux or macOS
.\venv\Scripts\activate # on Windows
  1. Install the required Python packages:
pip3 install -r requirements.txt

This will install all the necessary dependencies.

  1. Run project:
python manage.py runserver

4.5 Run Stramlit:

streamlit run main.py

References

Contributing

Contributions to this project are welcome. If you find a bug, have a feature request, or want to contribute code, please open an issue or pull request on the project's GitHub page.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

An answer-based search engine that delivers concise results about No Man's Sky related questions.

License:MIT License


Languages

Language:Python 90.2%Language:HTML 5.3%Language:Sass 4.6%