From fc93a98776166c5a0a8c99c1085a1b9c2c6dc44a Mon Sep 17 00:00:00 2001 From: Philip Gao Date: Wed, 3 Apr 2024 10:08:52 +0000 Subject: [PATCH] Fix --- src/promptflow-azure/{README.md => README.md_.md} | 0 .../azure/_restclient/{README.md => README.md_.md} | 0 src/promptflow-core/{README.md => README.md_.md} | 2 +- src/promptflow-devkit/{README.md => README.md_.md} | 2 +- .../chat_flow/flow_files/{README.md => README.md_.md} | 0 .../promptflow/_sdk/_service/{README.md => README.md_.md} | 8 ++++---- .../_sdk/data/docker/{README.md => README.md_.md} | 0 .../_sdk/data/docker_csharp/{README.md => README.md_.md} | 0 .../_sdk/data/executable/{README.md => README.md_.md} | 0 src/promptflow-evals/{README.md => README.md_.md} | 0 src/promptflow-recording/{README.md => README.md_.md} | 0 src/promptflow-tools/{README.md => README.md_.md} | 0 src/promptflow-tracing/{README.md => README.md_.md} | 0 src/promptflow/{README.md => README.md_.md} | 0 .../{README.md => README.md_.md} | 0 .../assistant-with-file/{README.md => README.md_.md} | 0 .../{README.md => README.md_.md} | 0 .../{README.md => README.md_.md} | 0 .../flows/export/linux/{README.md => README.md_.md} | 0 .../food-calorie-assistant/{README.md => README.md_.md} | 0 .../snapshot/{README.md => README.md_.md} | 0 21 files changed, 6 insertions(+), 6 deletions(-) rename src/promptflow-azure/{README.md => README.md_.md} (100%) rename src/promptflow-azure/promptflow/azure/_restclient/{README.md => README.md_.md} (100%) rename src/promptflow-core/{README.md => README.md_.md} (98%) rename src/promptflow-devkit/{README.md => README.md_.md} (99%) rename src/promptflow-devkit/promptflow/_cli/data/chat_flow/flow_files/{README.md => README.md_.md} (100%) rename src/promptflow-devkit/promptflow/_sdk/_service/{README.md => README.md_.md} (90%) rename src/promptflow-devkit/promptflow/_sdk/data/docker/{README.md => README.md_.md} (100%) rename src/promptflow-devkit/promptflow/_sdk/data/docker_csharp/{README.md => README.md_.md} (100%) rename src/promptflow-devkit/promptflow/_sdk/data/executable/{README.md => README.md_.md} (100%) rename src/promptflow-evals/{README.md => README.md_.md} (100%) rename src/promptflow-recording/{README.md => README.md_.md} (100%) rename src/promptflow-tools/{README.md => README.md_.md} (100%) rename src/promptflow-tracing/{README.md => README.md_.md} (100%) rename src/promptflow/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/assistant-tool-with-connection/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/assistant-with-file/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/assistant-with-package-tool/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/chat-with-assistant-no-file/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/export/linux/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/flows/food-calorie-assistant/{README.md => README.md_.md} (100%) rename src/promptflow/tests/test_configs/runs/web_classification_variant_0_20231205_120253_104100/snapshot/{README.md => README.md_.md} (100%) diff --git a/src/promptflow-azure/README.md b/src/promptflow-azure/README.md_.md similarity index 100% rename from src/promptflow-azure/README.md rename to src/promptflow-azure/README.md_.md diff --git a/src/promptflow-azure/promptflow/azure/_restclient/README.md b/src/promptflow-azure/promptflow/azure/_restclient/README.md_.md similarity index 100% rename from src/promptflow-azure/promptflow/azure/_restclient/README.md rename to src/promptflow-azure/promptflow/azure/_restclient/README.md_.md diff --git a/src/promptflow-core/README.md b/src/promptflow-core/README.md_.md similarity index 98% rename from src/promptflow-core/README.md rename to src/promptflow-core/README.md_.md index 0e9121ac628..e03e834b76f 100644 --- a/src/promptflow-core/README.md +++ b/src/promptflow-core/README.md_.md @@ -5,7 +5,7 @@ [![SDK](https://img.shields.io/badge/SDK-reference-blue)](https://microsoft.github.io/promptflow/reference/python-library-reference/promptflow-core/promptflow.html) [![PyPI - Downloads](https://img.shields.io/pypi/dm/promptflow-core)](https://pypi.org/project/promptflow-core/) -## Introduction +## Introduction The `promptflow-core` package provides the essential features needed to execute a `flow` in prompt flow. diff --git a/src/promptflow-devkit/README.md b/src/promptflow-devkit/README.md_.md similarity index 99% rename from src/promptflow-devkit/README.md rename to src/promptflow-devkit/README.md_.md index b6f918fd93e..4547464126e 100644 --- a/src/promptflow-devkit/README.md +++ b/src/promptflow-devkit/README.md_.md @@ -32,7 +32,7 @@ The `promptflow-devkit` is a subpackage of [`promptflow`](https://pypi.org/proje - Deploy your flow to the serving platform you choose or integrate into your app's code base easily. -NOTE: +NOTE: - For users seeking a **minimal** dependency to execute a flow in serving or cloud run scenarios, consider installing the `promptflow-core` package. This package equips you with the fundamental features necessary for executing a `flow` in prompt flow. - For users need to leverage the cloud version of [prompt flow in Azure AI](https://learn.microsoft.com/en-us/azure/machine-learning/prompt-flow/overview-what-is-prompt-flow?view=azureml-api-2), please install the `promptflow-azure` package. diff --git a/src/promptflow-devkit/promptflow/_cli/data/chat_flow/flow_files/README.md b/src/promptflow-devkit/promptflow/_cli/data/chat_flow/flow_files/README.md_.md similarity index 100% rename from src/promptflow-devkit/promptflow/_cli/data/chat_flow/flow_files/README.md rename to src/promptflow-devkit/promptflow/_cli/data/chat_flow/flow_files/README.md_.md diff --git a/src/promptflow-devkit/promptflow/_sdk/_service/README.md b/src/promptflow-devkit/promptflow/_sdk/_service/README.md_.md similarity index 90% rename from src/promptflow-devkit/promptflow/_sdk/_service/README.md rename to src/promptflow-devkit/promptflow/_sdk/_service/README.md_.md index cb7145a7f4d..4931abcacdd 100644 --- a/src/promptflow-devkit/promptflow/_sdk/_service/README.md +++ b/src/promptflow-devkit/promptflow/_sdk/_service/README.md_.md @@ -20,13 +20,13 @@ If you don't specify a port to start service, pfs will first use the port in the If not found port configuration or the port is used, pfs will use a random port to start the service. ### Swagger of service -After start the service, it will provide Swagger UI documentation, served from "http://localhost:your-port/v1.0/swagger.json". +After start the service, it will provide Swagger UI documentation, served from "http://localhost:your-port/v1.0/swagger.json". For details, please refer to [swagger.json](./swagger.json). #### Generate C# client -1. Right click the project, Add -> Rest API Client... -> Generate with OpenAPI Generator - +1. Right click the project, Add -> Rest API Client... -> Generate with OpenAPI Generator + 2. It will open a dialog, fill in the file name and swagger url, it will generate the client under the project. -For details, please refer to [REST API Client Code Generator](https://marketplace.visualstudio.com/items?itemName=ChristianResmaHelle.ApiClientCodeGenerator2022). \ No newline at end of file +For details, please refer to [REST API Client Code Generator](https://marketplace.visualstudio.com/items?itemName=ChristianResmaHelle.ApiClientCodeGenerator2022). diff --git a/src/promptflow-devkit/promptflow/_sdk/data/docker/README.md b/src/promptflow-devkit/promptflow/_sdk/data/docker/README.md_.md similarity index 100% rename from src/promptflow-devkit/promptflow/_sdk/data/docker/README.md rename to src/promptflow-devkit/promptflow/_sdk/data/docker/README.md_.md diff --git a/src/promptflow-devkit/promptflow/_sdk/data/docker_csharp/README.md b/src/promptflow-devkit/promptflow/_sdk/data/docker_csharp/README.md_.md similarity index 100% rename from src/promptflow-devkit/promptflow/_sdk/data/docker_csharp/README.md rename to src/promptflow-devkit/promptflow/_sdk/data/docker_csharp/README.md_.md diff --git a/src/promptflow-devkit/promptflow/_sdk/data/executable/README.md b/src/promptflow-devkit/promptflow/_sdk/data/executable/README.md_.md similarity index 100% rename from src/promptflow-devkit/promptflow/_sdk/data/executable/README.md rename to src/promptflow-devkit/promptflow/_sdk/data/executable/README.md_.md diff --git a/src/promptflow-evals/README.md b/src/promptflow-evals/README.md_.md similarity index 100% rename from src/promptflow-evals/README.md rename to src/promptflow-evals/README.md_.md diff --git a/src/promptflow-recording/README.md b/src/promptflow-recording/README.md_.md similarity index 100% rename from src/promptflow-recording/README.md rename to src/promptflow-recording/README.md_.md diff --git a/src/promptflow-tools/README.md b/src/promptflow-tools/README.md_.md similarity index 100% rename from src/promptflow-tools/README.md rename to src/promptflow-tools/README.md_.md diff --git a/src/promptflow-tracing/README.md b/src/promptflow-tracing/README.md_.md similarity index 100% rename from src/promptflow-tracing/README.md rename to src/promptflow-tracing/README.md_.md diff --git a/src/promptflow/README.md b/src/promptflow/README.md_.md similarity index 100% rename from src/promptflow/README.md rename to src/promptflow/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/assistant-tool-with-connection/README.md b/src/promptflow/tests/test_configs/flows/assistant-tool-with-connection/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/assistant-tool-with-connection/README.md rename to src/promptflow/tests/test_configs/flows/assistant-tool-with-connection/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/assistant-with-file/README.md b/src/promptflow/tests/test_configs/flows/assistant-with-file/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/assistant-with-file/README.md rename to src/promptflow/tests/test_configs/flows/assistant-with-file/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/assistant-with-package-tool/README.md b/src/promptflow/tests/test_configs/flows/assistant-with-package-tool/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/assistant-with-package-tool/README.md rename to src/promptflow/tests/test_configs/flows/assistant-with-package-tool/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/chat-with-assistant-no-file/README.md b/src/promptflow/tests/test_configs/flows/chat-with-assistant-no-file/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/chat-with-assistant-no-file/README.md rename to src/promptflow/tests/test_configs/flows/chat-with-assistant-no-file/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/export/linux/README.md b/src/promptflow/tests/test_configs/flows/export/linux/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/export/linux/README.md rename to src/promptflow/tests/test_configs/flows/export/linux/README.md_.md diff --git a/src/promptflow/tests/test_configs/flows/food-calorie-assistant/README.md b/src/promptflow/tests/test_configs/flows/food-calorie-assistant/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/flows/food-calorie-assistant/README.md rename to src/promptflow/tests/test_configs/flows/food-calorie-assistant/README.md_.md diff --git a/src/promptflow/tests/test_configs/runs/web_classification_variant_0_20231205_120253_104100/snapshot/README.md b/src/promptflow/tests/test_configs/runs/web_classification_variant_0_20231205_120253_104100/snapshot/README.md_.md similarity index 100% rename from src/promptflow/tests/test_configs/runs/web_classification_variant_0_20231205_120253_104100/snapshot/README.md rename to src/promptflow/tests/test_configs/runs/web_classification_variant_0_20231205_120253_104100/snapshot/README.md_.md