README.md

metadata

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

Arena

Get Involved: Discuss and contribute on GitHub

How to run locally

1. Set up a virtual environment

   Before installing dependencies, it's recommended to create a virtual environment.

2. Install dependencies

   With the virtual environment activated, install the project dependencies:

   pip install -r requirements.txt
   

3. Run the app

   Set your OpenAI API key as an environment variable and start the application:

   GOOGLE_CLOUD_PROJECT=<your project id> \
   CREDENTIALS_PATH=<your crednetials path> \
   MODELS_SECRET=<your secret> \
   OPENAI_API_KEY=<your key> \
   ANTHROPIC_API_KEY=<your key> \
   MISTRAL_API_KEY=<your key> \
   GEMINI_API_KEY=<your key> \
   GROQ_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.