Skip to content

Commit

Permalink
updated folder structure to simply discovery and contributions (#121)
Browse files Browse the repository at this point in the history
* updated folder structure to simply discovery and contributions

* updated assets folder

* removed dotnet folder from parent
  • Loading branch information
thegovind authored Jul 14, 2023
1 parent b534040 commit f17d276
Show file tree
Hide file tree
Showing 533 changed files with 147 additions and 61 deletions.
65 changes: 65 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributing to Miyagi

We welcome community contributions with issues and pull requests (PRs). Please be sure to read and follow our Code of Conduct.

## Code of Conduct

[Link to Code of Conduct]

## Reporting Issues

Navigate to [issues](https://github.com/Azure-Samples/miyagi/issues), and submit an issue with the template below.
For feedback and discussions, please use the [Discussion tab](https://github.com/Azure-Samples/miyagi/discussions).

Before filing a new issue, please search the list of issues to make sure it does not already exist...

### Writing a Good Bug Report

Good bug reports make it easier for maintainers to verify and root cause the underlying problem...

## Contributing Changes

Project maintainers will merge accepted code changes from contributors. All contributors should include unit tests for their changes, if applicable. Please see our [Testing Guidelines-TODO](#) for more information.

### Development Environment Setup

Before you start contributing, please ensure that your development environment meets the following requirements:

[List of requirements and setup steps]

### DOs and DON'Ts

DO's:

- **DO** follow the standard coding conventions...

DON'Ts:

[List of practices to avoid]

### Breaking Changes

Contributions must maintain API signature and behavioral compatibility...

### Suggested Workflow

We use and recommend the following workflow:

1. Create an issue for your work...
2. Create a personal fork of the repository on GitHub...
3. In your fork, create a branch off of main (`git checkout -b mybranch`)...
4. Make and commit your changes to your branch.
5. Add new tests corresponding to your change, if applicable.
6. Create a PR against the repository's **main** branch...
7. Wait for feedback or approval of your changes from the code maintainers.
8. When area owners have signed off, and all checks are green, your PR will be merged...

Examples of trivial changes include minor documentation updates or changes in comments.

### PR Review Process

Upon submission of your PR, it will be reviewed by [number] of reviewers. The review process typically takes [time frame], but this can vary depending on the complexity of the changes and the current workload of the reviewers.

### PR - CI Process

The continuous integration (CI) system will automatically perform the required builds and run tests...
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ 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. [Miyagi ChatGPT Plugin](./python/chatgpt-plugin-miyagi)
1. [Knowledge Graph memory using Langchain's entity cache](./usecases/experiments/langchain/Memory_Usecases.ipynb)
1. [Qdrant vector store for embeddings via Langchain](./usecases/experiments/langchain/qdrant_miyagi_example)
1. [MS Graph API intent invoked via Semantic Kernel's skills](./usecases/experiments/semantic-kernel/ms-graph-chain)
1. [Miyagi prompt engineered chat interaction](./usecases/experiments/langchain/chat) using LangChain's PromptTemplate
1. [Azure OpenAI GPT-3.5 basic flow](./usecases/experiments/az-openai)
1. [GPT-3.5-turbo and Whisper-1 usage to transcribe audio and demonstrate few-shot example](./usecases/experiments/gpt-3.5-turbo)
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)
1. [MS Graph API intent invoked via Semantic Kernel's skills](./sandbox/experiments/semantic-kernel/ms-graph-chain)
1. [Miyagi prompt engineered chat interaction](./sandbox/experiments/langchain/chat) using LangChain's PromptTemplate
1. [Azure OpenAI GPT-3.5 basic flow](./sandbox/experiments/az-openai)
1. [GPT-3.5-turbo and Whisper-1 usage to transcribe audio and demonstrate few-shot example](./sandbox/experiments/gpt-3.5-turbo)
1. [DeepSpeed Chat](https://github.com/microsoft/DeepSpeedExamples/tree/master/applications/DeepSpeed-Chat) MiyagiGPT (BYO Weights w/ RLHF - Reinforcement Learning from Human Feedback) - coming soon

### Frontend
Expand Down
35 changes: 35 additions & 0 deletions deploy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Deployment steps

## Prerequisites

- [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

### Deploying the solution using Azure Portal

1. Click on the **Deploy to

<img src="https://aka.ms/deploytoazurebutton"" alt="Deploy to Azure" />

2. Fill in the required parameters


### Deploying the solution using Azure CLI

1. Clone the repository

```bash
git clone
```
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
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
37 changes: 0 additions & 37 deletions dotnet/Miyagi.sln

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Energy Demand: Demand for crude oil may have peaked in 2019 at 100.5 million bar

For informational purposes only and should not be considered investment advice or a recommendation to buy, sell, or hold any particular security. Forecasts are inherently limited and cannot be relied upon.

https://iea.blob.core.windows.net/assets/830fe099-5530-48f2-a7c1-11f35d510983/WorldEnergyOutlook2022.pdf, as of November 2022. https://www.bp.com/en/global/corporate/energy-economics/energy-outlook/oil-demand.html, as of March 2022.
https://iea.blob.core.windows.net/sandbox/assets/830fe099-5530-48f2-a7c1-11f35d510983/WorldEnergyOutlook2022.pdf, as of November 2022. https://www.bp.com/en/global/corporate/energy-economics/energy-outlook/oil-demand.html, as of March 2022.

Genomic Revolution
Base Editing: In 2022, thanks to a new form of gene editing, a young girl in the UK with leukemia went from her death bed in May to cancer-free in November. Base editing and multiplexing have the potential to provide more effective CAR-T treatments for patients with otherwise incurable cancers.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion semantic-kernel
Submodule semantic-kernel deleted from b24c7d
28 changes: 28 additions & 0 deletions services/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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.

## Use cases implemented

# 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.

## Use cases implemented

| 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 | |

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

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ user authentication and will be able to answer questions about the user's portfo
1. Go to [ai.com](https://ai.com) and from New Chat, under GPT-4, select Plugins
1. From the Plugin store dialog, Click on `Develop your own plugin`
1. Under Domain, enter `http://localhost:8000` and click on `Find Manifest`
![find-manifest](../../assets/images/plugins/find-manifest.png)
![find-manifest](../../../assets/images/plugins/find-manifest.png)
1. Install localhost plugin
![install-plugin](../../assets/images/plugins/install-plugin.png)
![install-plugin](../../../assets/images/plugins/install-plugin.png)
1. Select plugin and interact
![plugin](../../assets/images/plugin.png)
![interact](../../assets/images/plugins/interact.png)
![plugin](../../../assets/images/plugin.png)
![interact](../../../assets/images/plugins/interact.png)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Recommendation Service

Microservice that leverages Semantic Kernel to orchestrate the recommendation flow with native and semantic functions,
along with vector stores and connectors.
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/)

## Overview

![Recommendation Service](../../assets/images/sk-memory-orchestration.png)
![Recommendation Service](../../../assets/images/sk-memory-orchestration.png)

## Getting Started

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit f17d276

Please sign in to comment.