1
0
mirror of https://github.com/MarkParker5/STARK.git synced 2024-11-24 08:12:13 +02:00
STARK/docs/index.md
2023-09-19 17:34:35 +02:00

2.7 KiB

Welcome to S.T.A.R.K.

Speech and Text Algorithmic Recognition Kit

Welcome to S.T.A.R.K., a modern, advanced, asynchronous, and fast framework designed for creating intuitive natural language interfaces, especially voice-based. Think of it as the FastAPI but with speech instead of http.

New to S.T.A.R.K.? Consider reading the articles in navigation sequentially for a comprehensive understanding of the framework, including the "Advanced" section.


🔍 Key Features

  • 🛡️ Autonomous and Privacy-Focused: Stark operates entirely on-device, ensuring your data remains private. Dive deeper into hosting options here.

  • 🧠 Context-Aware: Easily define context and parameters for subsequent requests or parse multiple commands simultaneously. Discover the power of Commands Context.

  • 🚀 Asynchronous Commands: Start lengthy tasks and continue using Stark. You'll be notified upon completion. Learn about Sync vs Async Commands and Creating Commands.

  • 📈 Multiple Responses: Get real-time updates for long tasks, like monitoring download progress. More on this in Creating Commands.

  • 🧩 Advanced Patterns Parsing: Our custom patterns syntax makes parsing any parameter from strings effortless.

  • 🧠 Extendable with LLMs: Enhance Stark's cognition by integrating leading language models like ChatGPT. More in Fallback Command

  • 🌐 Multilingual Support: Interact with Stark in multiple languages.

  • 🔧 Absolute Customization: Craft complex commands, integrate various speech or text interfaces, adapt voice assistant modes, or even override existing classes.

  • 🌍 Community Support: Join STARK-PLACE repository, the platform library filled with community extensions. Utilize commands crafted by others and share your creations. Further information in Contributing and Shared Usage.


License

The S.T.A.R.K. project is licensed under the CC BY-NC-SA 4.0 International license. You're welcome to modify, contribute to the repository, create, and share forks. Just remember to attribute the original repository and its creator, abstain from commercial use, and retain the existing license.

Note: Failing to provide the necessary attribution or using the project for commercial purposes breaches the licensing terms and could have legal consequences.