Code Monkey home page Code Monkey logo

fab-simulated-universe's Introduction

Review Assignment Due Date

Team Members

Name - Student Number

Max Herget        -  0580332
Nicolas Marantos  -  0579813
Leon Schüßler     -  0579906

Flesh and Blood Simulated Universe

Welcome to the Flesh and Blood Simulated Universe - a place where epic tales and legendary heroes come to life!

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker/Docker Desktop
  • Docker Compose

Environment Setup

  1. Clone the repository to your local machine.

  2. Navigate to the project root directory.

  3. Create a .env file with the necessary environment variables:

    OPENAI_API_KEY=<Your OpenAI API Key>
    APP_SECRET_KEY=<Your Application Secret Key>

Build and Run

Run the following command to build and start the Docker containers:

docker-compose up --build -d

This will set up all necessary services, including the backend, ChromaDB, and any other required components.

Initialize Database

After the containers are up and running, initialize the database:

  • Access the localhost:8082/heroes/importCollection/heroes endpoint in your browser. This loads the data into the "heroes" collection in your ChromaDB (that's the one with Chromas default Embeddings).
  • If you wish to load the data with OpenAIs Embeddings as well, access the localhost:8082/openai/importCollection/heroes endpoint.
  • If you want to import a different name_collection.json, or load it into a different created Collection, just use this syntax:
  • localhost:8082/<chroma_collection_name>/importCollection/<filename_before_collection.json>

Using different Embeddings

If you want to use different Embeddings, please refer to this Notebook by Chroma.

Features

  • Personality Generation: Create unique hero profiles with rich backstories and attributes based on existing stories.
  • Story Generation: Generate captivating stories involving the heroes and existing World Data.
  • Question Asking: Ask Questions about the current State of the Universe.

To-Do Roadmap

  • Information Adding Feature
  • Hero Chatbot for Consultation sessions: Where they talk and think about what is currently happening, what to do next, which then gets saved as special object to ChromaDB.
  • Allow User Editing of Ratings
  • Use SelfQueryRetriever from LangChain to query over the Ratings Metadatas Fields

Contributing

We welcome contributions! If you have ideas or suggestions, please open an issue or submit a pull request.

fab-simulated-universe's People

Contributors

altarisv avatar nicomarantos avatar github-classroom[bot] avatar

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.