From 4a7898f027e2a47c04d9326161d9df4eb688d7c7 Mon Sep 17 00:00:00 2001 From: Aleksandr Movchan Date: Fri, 21 Jun 2024 15:13:40 +0000 Subject: [PATCH] Updated README --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc87017..0e7321e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# aana_app_template -A template for applications built on top of Aana SDK +# Aana Application Template + +[Aana SDK](https://github.com/mobiusml/aana_sdk) is a powerful framework for building multimodal applications. It facilitates the large-scale deployment of machine learning models, including those for vision, audio, and language, and supports Retrieval-Augmented Generation (RAG) systems. This enables the development of advanced applications such as search engines, recommendation systems, and data insights platforms. + +This repository contains a template that you can use to start building your own Aana application. It will help you get started with the Aana SDK and provide you with a basic structure for your application and its dependencies. + +## How to use this template + +1. Click on [Use this template](https://github.com/mobiusml/aana_app_template/generate). +2. Give your repository a name and click on "Create repository". The name of the repository will also be the name of your application and the Python package. +3. Wait for the first workflow to finish. This will rename the package to match the repository name. +4. Clone the repository to your local machine and start building your application. + +## Getting started + +The project template uses [Poetry](https://python-poetry.org/) for dependency management. To install the project, run the following commands: + +```bash +poetry install +``` + +See [Tutorial](https://github.com/mobiusml/aana_sdk/blob/main/docs/tutorial.md) for more information on how to build your application. +