Skip to content

Commit

Permalink
update readmes to fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
thegovind committed Jul 15, 2023
1 parent ce69915 commit fa05669
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 35 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ Embark on a journey to transform your applications into cutting-edge, intelligen

Due to the rapid pace of advancements in foundation models, we are incrementally implementing use cases for Miyagi in the experiments folder. So far, we have the following implemented:

1. [MVP with Personalize (Synthesis via Semantic Kernel) and Chat on Azure Container Apps](https://agentmiyagi.com)
1. [MVP with Personalize (Synthesis via Semantic Kernel) and Chat on Azure Container Apps](https://agentmiyagi.com).
1. [Detailed breakdown and implementations](./services/README.md)
1. [Miyagi ChatGPT Plugin](./services/chatgpt-plugin/python)
1. [Knowledge Graph memory using Langchain's entity cache](./sandbox/experiments/langchain/Memory_Usecases.ipynb)
1. [Qdrant vector store for embeddings via Langchain](./sandbox/experiments/langchain/qdrant_miyagi_example)
Expand Down
29 changes: 14 additions & 15 deletions deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,33 @@

## Prerequisites

- [Azure SUbscription](https://azure.microsoft.com/en-us/free/)
- [Azure Subscription](https://azure.microsoft.com/en-us/free/)
- [Azure OpenAI](https://aka.ms/oai/access) access with the following models
- gpt-35-turbo
- text-embedding-ada-002


## Deploying the solution in your Azure subscription

>TODO: We welcome community contributions, see [CONTRIBUTING.md](../CONTRIBUTING.md) for details
### Deploying the solution using Azure Portal

1. Click on the **Deploy to
1. Click on the "Deploy to Azure" button (TODO)

<img src="https://aka.ms/deploytoazurebutton"" alt="Deploy to Azure" />
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](#)

2. Fill in the required parameters


### Deploying the solution using Azure CLI

1. Clone the repository
1. Clone the repository. Replace `your-repo-url` with the actual repository URL.

```bash
git clone your-repo-url
```

2. Configure and run Deploy scripts (TODO)

```bash
git clone
cd your-repo-name/deploy/infrastructure
code config.json
./deploy.sh
```
2. Configure and run Deploy scripts (TODO: We welcome community contributions, see [CONTRIBUTING.md](../CONTRIBUTING.md) for details)

```bash
cd miyagi/deploy/infrastructure
code config.json
./deploy.sh
```
35 changes: 17 additions & 18 deletions services/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# Miyagi Services

This folder contains the microservices that implement the [use cases](https://iappwksp.com/wksp/05-use-cases/) for intelligent apps using Miyagi sample.
This folder contains the microservices that implement the [use cases](https://iappwksp.com/wksp/05-use-cases/) for intelligent apps using the Miyagi sample.

## Use cases implemented

# Miyagi Services
### Generative AI

This folder contains the microservices that implement the [use cases](https://iappwksp.com/wksp/05-use-cases/) for intelligent apps using Miyagi sample.
| Use Case | Subfolder |
|----------|-----------|
| Synthesis & Summarization | [recommendation-service](./recommendation-service/dotnet/) |
| Images | [reddog-repo](https://github.com/Azure/reddog-solutions) [inference](https://huggingface.co/thegovind/reddogpillmodel512) |
| Code | [sql-code-gen.ipynb](../sandbox/generative/code-gen/sk-c#/sql-code-gen.ipynb) |
| Chat (Q&A) | [sk-copilot-chat-api](../services/sk-copilot-chat-api/) |
| Synthetic data | [user-service](./user-service/java/) |

## Use cases implemented
### Discriminative

| Use Case Category | Use Case | Subfolder |
|-------------------|----------|-----------|
| Generative AI | Synthesis | [recommendation-service](./recommendation-service) |
| Generative AI | Images | [reddog](https://huggingface.co/thegovind/reddogpillmodel512) |
| Generative AI | Code | [sql-code-gen.ipynb](../sandbox/generative/code-gen/sdk-c#/sql-code-gen.ipynb) |
| Generative AI | Chat (Q&A) | [sk-copilot-chat-api](../sk-copilot-chat-api) |
| Generative AI | Synthetic data | [user-service](./user-service) |
| Discriminative | Classification | [expense-service](./expense-service) |
| Discriminative | Translation | |
| Discriminative | Analysis | [./expense-service](./expense-service) |
| Discriminative | Entity Extraction |[Memory usecase](../sandbox/experiments/langchain/Memory_Usecases.ipynb) |
| Discriminative | Anomaly Detection | |
| Use Case | Subfolder |
|----------|-----------|
| Classification | [expense-service](./expense-service/python/) |
| Translation | |
| Analysis | [./expense-service](./expense-service/python/) |
| Entity Extraction |[Memory usecase](../sandbox/experiments/langchain/Memory_Usecases.ipynb) |
| Anomaly Detection | |

> Please note that some use cases are currently under development and do not yet have associated subfolders.

2 changes: 2 additions & 0 deletions services/recommendation-service/dotnet/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Microservice that leverages Semantic Kernel to orchestrate the recommendation flow with native and semantic functions,
along with vector stores and connectors. The key aspects of this service will be distilled in the [Synthesis use case](https://iappwksp.com/wksp/05-use-cases/synthesis/)

> Tip: For advanced deep learning-based recommender systems, checout [microsoft/recommenders](https://github.com/microsoft/recommenders#algorithms) for complex DLRMs.
## Overview

![Recommendation Service](../../../assets/images/sk-memory-orchestration.png)
Expand Down
2 changes: 1 addition & 1 deletion ui/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ yarn install
yarn dev
```
### Screenshots
<img src="../../../assets/images/wip-ui.png" />
<img src="../../assets/images/wip-ui.png" />


<img src="public/images/readme/1.png" width=30% height=30% />
Expand Down

0 comments on commit fa05669

Please sign in to comment.