PhoenixUI / README.md
mgbam's picture
Update README.md
4ef5154 verified
|
raw
history blame
5.58 kB
metadata
title: EDAONSTERIOD
emoji: 👀
colorFrom: green
colorTo: indigo
sdk: gradio
sdk_version: 5.34.0
app_file: app.py
pinned: false
short_description: Analytic

🔥 Odyssey: The AI Data Science Workspace

License: MIT Python Version Status Built with Gradio

Odyssey is not just an analytic tool; it's an AI-native, collaborative workspace designed to augment and accelerate the entire data science workflow. It moves beyond reactive profiling to a proactive, guided exploration experience, making you feel like you have a senior data scientist as your co-pilot.

(A conceptual image of the Odyssey UI)

✨ Core Features

Odyssey is built around four intelligent modules and a project-based workflow, providing a seamless journey from raw data to actionable insight.

  • 🔭 Helios Overview: A living, proactive dashboard that automatically runs upon data upload. It doesn't just show you stats; it surfaces critical insights like data quality issues, strong correlations, outlier alerts, and even suggests potential target variables for machine learning.

  • 🧪 Asclepius Data Lab: An interactive data preparation environment. Go beyond simple imputation with advanced methods like KNN for numeric data and smart categorical handling. See the impact of your changes instantly with live before-and-after visualizations.

  • 🚀 Prometheus Launchpad: A rapid machine learning modeling environment. Select a target and features, and with one click, train a model using robust 5-fold cross-validation. Instantly receive key performance metrics and advanced visualizations like ROC curves and residual plots to assess model viability.

  • 💡 Athena Co-pilot: A true AI collaborator. Athena understands the full context of your session—from the original data to the cleaned dataset and the models you've built. Ask it to perform complex analyses, generate plots, or even build new, dynamic dashboards on the fly right inside the chat.

  • 🗂️ Project-Based Workflow: Save your entire session—including cleaned data, chat history, and insights—into a single .odyssey file. Load projects later to pick up exactly where you left off.

  • 📄 One-Click HTML Reports: Generate a comprehensive, self-contained HTML report of your entire analysis, perfect for sharing with colleagues or stakeholders.

🚀 Getting Started

Follow these steps to get Odyssey running on your local machine.

Prerequisites

  • Python 3.9 or higher
  • pip package manager
  • git for cloning the repository

1. Clone the Repository

Open your terminal and clone the project:

git clone https://github.com/your-username/odyssey-ai-workspace.git
cd odyssey-ai-workspace

2. Set Up a Virtual Environment

It is highly recommended to use a virtual environment to manage dependencies and avoid conflicts.

On macOS/Linux:

python3 -m venv venv
source venv/bin/activate

On Windows:

python -m venv venv
.\venv\Scripts\activate

3. Install Dependencies

Install all required packages using the requirements.txt file:

pip install -r requirements.txt

4. Set Up Your API Key

Odyssey's AI features are powered by the Google Gemini API.

  1. Obtain a free API key from Google AI Studio.
  2. When you launch the application, you will see a field labeled "Gemini API Key". Paste your key there to activate the Athena Co-pilot and other AI features.

5. Run the Application

Launch the Gradio application with the following command:

python odyssey_app.py

(Assuming the main script is named odyssey_app.py)

Open your web browser and navigate to the local URL provided in the terminal (usually http://127.0.0.1:7860).

🧭 How to Use Odyssey

  1. Start a Project: Give your project a name and upload a CSV file.
  2. Consult Helios: Once uploaded, the Helios Overview will automatically populate with proactive insights. Review these findings to understand your data's strengths and weaknesses.
  3. Cleanse in the Lab: Navigate to the Asclepius Data Lab. Use the dropdowns to select columns with missing data and apply imputation methods, previewing the effects in real-time.
  4. Launch a Model: Go to the Prometheus Launchpad. Based on the suggestions from Helios, select a target variable and features. Choose a model and click "Launch" to see its predictive potential.
  5. Collaborate with Athena: Open the Athena Co-pilot. Ask complex questions, request specific plots, or even ask it to build a custom dashboard (e.g., "Build me a dashboard showing sales trends by region and product category.").
  6. Save or Export: Use the "Save" button to create a .odyssey file of your session, or click "Export Report" to generate a shareable HTML summary.

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please feel free to submit a pull request or open an issue for any bugs, feature requests, or suggestions.

📝 License

This project is licensed under the MIT License. See the LICENSE file for more details. Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference