Skip to content

Commit

Permalink
re-align the ROADMAP.md with the llama-cpp-agent framework.
Browse files Browse the repository at this point in the history
  • Loading branch information
suparious committed Jun 21, 2024
1 parent ef5ad53 commit 74b9b3e
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,28 @@ This document outlines the future objectives and plans for the `srt-agent-api` p
The project currently supports the following functionalities:

- Chat module with API and CLI interfaces.
- API endpoints for fetching data, wiki summaries, Wikipedia queries, and web searches.
- API endpoints for fetching data, wiki summaries, Wikipedia queries, web searches, and translations.
- Configurable via `config.yaml`.
- CI/CD pipeline set up for automated testing.
- Dockerization with Docker and Docker Compose support.

## Future Objectives

### Leveraging `llama-cpp-agent` Framework

1. **Incorporate More Tools**
- Explore additional tools provided by the `llama-cpp-agent` and see how they can be integrated.

2. **Refine Existing Modules**
- Use examples from `llama-cpp-agent` to refine and enhance current modules, improving their functionality and performance.

3. **New Functionality**
- Explore new functionalities inspired by the `llama-cpp-agent` repository that can be added to our current setup.

### New Module Ideas

1. **Translation Module**
- Implement a tool to translate text using an LLM provider.
- Implemented. Continue refining and expanding language support using the `llama-cpp-agent` framework.

2. **Sentiment Analysis Module**
- Create a tool to analyze the sentiment of text inputs.
Expand All @@ -28,17 +39,6 @@ The project currently supports the following functionalities:
4. **Entity Recognition Module**
- Implement a tool that identifies and extracts entities from text.

### Reviewing Examples from `llama-cpp-agent` Repository

1. **Incorporate More Tools**
- Explore additional tools provided by the `llama-cpp-agent` and see how they can be integrated.

2. **Refine Existing Modules**
- Use examples to refine and enhance current modules, improving their functionality and performance.

3. **New Functionality**
- Explore new functionalities that can be added to our current setup.

### Improve Documentation and Developer Experience

1. **API Documentation**
Expand Down Expand Up @@ -73,7 +73,7 @@ The project currently supports the following functionalities:

### Phase 1: Immediate Goals

- **Review Examples from `llama-cpp-agent` Repository**
- **Leverage `llama-cpp-agent` Examples**
- Incorporate more tools.
- Refine existing modules.
- **Improve Documentation and Developer Experience**
Expand All @@ -82,8 +82,8 @@ The project currently supports the following functionalities:
### Phase 2: Near-term Goals

- **New Module Ideas**
- Translation Module.
- Sentiment Analysis Module.
- Summarization Module.
- **Enhance Testing and CI/CD**
- Increase test coverage.

Expand All @@ -92,7 +92,6 @@ The project currently supports the following functionalities:
- **Distributed Architecture**
- Enable distributed architecture for better performance and scalability.
- **New Module Ideas**
- Summarization Module.
- Entity Recognition Module.
- **Prometheus Integration**
- Integrate Prometheus for enhanced monitoring and performance tracking.
Expand All @@ -103,4 +102,4 @@ This roadmap will be regularly updated to reflect the progress and changes in pr

## References

- [https://github.com/carlosperate/awesome-pyproject](https://github.com/carlosperate/awesome-pyproject)
- [llama-cpp-agent Examples Repository](https://github.com/Maximilian-Winter/llama-cpp-agent/tree/master/examples)

0 comments on commit 74b9b3e

Please sign in to comment.