diff --git a/README.md b/README.md index cfcd27b2..4d3b1bcb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # AlphaTrion **AlphaTrion** is an open-source and all-in-one platform to build LLM-powered applications. Named after the wise Transformer mentor, it embodies guidance and innovation to help developers build **production-ready** GenAI applications with ease. *Still under active development.* + +## How to Contribute + +We welcome all kinds of contributions! Please see our [contribution guidelines](CONTRIBUTING.md) for more details. + +Refer to [developer.md](./docs/development.md) for more information on how to set up your development environment. + +Refer to [our roadmap](./docs/roadmap.md) to see what features are coming next. + +[![Star History Chart](https://api.star-history.com/svg?repos=inftyai/alphatrion&type=Date)](https://www.star-history.com/#inftyai/alphatrion&Date) \ No newline at end of file diff --git a/docs/development.md b/docs/development.md index 9f902bca..7d9d5c19 100644 --- a/docs/development.md +++ b/docs/development.md @@ -5,7 +5,7 @@ - Python 3.12 or higher - Poetry for dependency management -## How to Develop +## How to Set Up We welcome contributions! Please follow these steps: @@ -14,18 +14,27 @@ We welcome contributions! Please follow these steps: 3. Install dependencies with `poetry install`. 4. Make your changes. + +## How to Test + +To run tests, use: + +```bash +make test +``` + ## How to Build and Publish > NOTE: You need to have the PyPI token set in your environment variables to publish the package. To build the project, run: -```cmd +```bash make build ``` To publish the project, run: -```cmd +```bash make publish ``` diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 00000000..77a322e8 --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,23 @@ +# RoadMap + +## 2024 Q3 (September Only) + +- Finish core modules: Experiment, Model, Checkpoint, Metric +- Add dashboard for experiment tracking and visualization + +## 2024 Q4 + +- Experiment logging +- Cost tracking for Experiments +- Playground for quick prototyping +- Prompt management system with versioning +- Prompt optimization tools integration, like DSPy + +## More + +- Model leaderboard for comparing different models +- Evaluation module for application performance assessment +- Dataset management and versioning +- Security and compliance features +- Chatbot framework for building conversational agents +- MCP tools integration