https://github.com/neeraj1bh/facts

https://github.com/neeraj1bh/facts

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/neeraj1bh/facts
• Owner: neeraj1bh
• Created: 2024-01-14T16:55:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-27T13:25:42.000Z (12 months ago)
• Last Synced: 2024-04-23T00:10:02.876Z (10 months ago)
• Language: Jupyter Notebook
• Size: 2.97 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Facts Trivia Program

## Overview

This program is designed to engage users with trivia facts, enabling inquiries into a collection of trivia facts stored within a `facts.txt` file. It utilizes the `langchain-openai` and other related packages to process and respond to user queries with relevant trivia information.

## Requirements

- Python 3.11

- Key Dependencies: langchain, openai, python-dotenv, tiktoken, chromadb, matplotlib, numpy, langchain-openai

- See `requirements.txt` for a complete list.

## Project Structure

- `Pipfile` and `Pipfile.lock` for managing Python package dependencies.

- `facts.txt`: Contains the trivia facts.

- `main.py`: The main script to run the trivia program.

- `prompt.py`, `redundant_filter_retriever.py`, `scores.py`: Auxiliary modules.

- `emb/`: Directory containing embedding data and `chroma.sqlite3` database.

- `scores.ipynb`: Jupyter notebook for analyzing scores.

## Setup

1. Install dependencies using Pipenv: `pipenv install`.

2. Ensure all required environment variables are set (check `.env` template if provided).

## Usage

Execute the program to start interacting with the trivia fact system:

```bash

python main.py

```