README.md

metadata

title: Yanolja Arena
emoji: ⚔️
colorFrom: red
colorTo: purple
sdk: gradio
python_version: 3.11
app_file: app.py
pinned: false

Yanolja Arena

Yanolja Arena is an open-source project designed to identify the most effective LLMs for summarization and translation tasks. It employs a comparative approach, evaluating two randomly selected models simultaneously and utilizing the ELO rating system to rank their performance.

Get Involved: Discuss and contribute on GitHub

How to run locally

1. Install Poetry and plugins

   First, ensure that Poetry is installed. You can install it by following the instructions on the Poetry website.

   After installing Poetry, install the following plugins:

   • poetry-plugin-sort
   • poetry-plugin-export
   • poetry-auto-export

2. Activate the virtual environment

   Use the following command to activate the virtual environment that Poetry has created:

   poetry shell
   

3. Install dependencies

   With the virtual environment activated, install the project dependencies:

   poetry install
   

4. Run the app

   Set your environment variables and run the app:

   CREDENTIALS_PATH=<your crednetials path> \
   RATINGS_COLLECTION=<your collection> \
   SUMMARIZATIONS_COLLECTION=<your collection> \
   TRANSLATIONS_COLLECTION=<your collection> \
   OPENAI_API_KEY=<your key> \
   ANTHROPIC_API_KEY=<your key> \
   GEMINI_API_KEY=<your key> \
   DEEPINFRA_API_KEY=<your key> \
   python3 app.py
   

   Replace the placeholders with your actual values.

   To run the app with auto-reloading, use gradio app.py --demo-name app instead of python3 app.py.

Handling GCP credentials for development and deployment

Local environment

1. Store your credentials in a file on your local machine.
2. Set the CREDENTIALS_PATH environment variable to point to this file.
3. The application will read the credentials from this file when running locally.

Deployment environment

1. Set the CREDENTIALS environment variable in your deployment platform's settings to your credentials JSON string.
2. The application will parse and use these credentials when deployed.

License

This project is licensed under the terms of the Apache 2.0 license. See the LICENSE file for more details.

Contributing

Before you submit any contributions, please make sure to review and agree to our Contributor License Agreement.

Code of Conduct

Please read our Code of Conduct before engaging with our community.