Merge remote-tracking branch 'origin/main' into deepinfra

samples/apps/autogen-studio/README.md

@@ -12,24 +12,14 @@ Code for AutoGen Studio is on GitHub at [microsoft/autogen](https://github.com/m
 > **Note**: AutoGen Studio is meant to help you rapidly prototype multi-agent workflows and demonstrate an example of end user interfaces built with AutoGen. It is not meant to be a production-ready app.
 
 > [!WARNING]
-> AutoGen Studio is currently under active development and we are iterating quickly. Kindly consider that we may introduce breaking changes in the releases during the upcoming weeks, and also the `README` might be outdated. We'll update the `README` as soon as we stabilize the API.
+> AutoGen Studio is currently under active development and we are iterating quickly. Kindly consider that we may introduce breaking changes in the releases during the upcoming weeks, and also the `README` might be outdated. Please see the AutoGen Studio [docs](https://microsoft.github.io/autogen/docs/autogen-studio/getting-started) page for the most up-to-date information.
+
+**Updates**
 
-> [!NOTE] Updates
 > April 17: AutoGen Studio database layer is now rewritten to use [SQLModel](https://sqlmodel.tiangolo.com/) (Pydantic + SQLAlchemy). This provides entity linking (skills, models, agents and workflows are linked via association tables) and supports multiple [database backend dialects](https://docs.sqlalchemy.org/en/20/dialects/) supported in SQLAlchemy (SQLite, PostgreSQL, MySQL, Oracle, Microsoft SQL Server). The backend database can be specified a `--database-uri` argument when running the application. For example, `autogenstudio ui --database-uri sqlite:///database.sqlite` for SQLite and `autogenstudio ui --database-uri postgresql+psycopg://user:password@localhost/dbname` for PostgreSQL.
 
 > March 12: Default directory for AutoGen Studio is now /home/<user>/.autogenstudio. You can also specify this directory using the `--appdir` argument when running the application. For example, `autogenstudio ui --appdir /path/to/folder`. This will store the database and other files in the specified directory e.g. `/path/to/folder/database.sqlite`. `.env` files in that directory will be used to set environment variables for the app.
 
-### Capabilities / Roadmap
-
-Some of the capabilities supported by the app frontend include the following:
-
-- [x] Build / Configure agents (currently supports two agent workflows based on `UserProxyAgent` and `AssistantAgent`), modify their configuration (e.g. skills, temperature, model, agent system message, model etc) and compose them into workflows.
-- [x] Chat with agent works and specify tasks.
-- [x] View agent messages and output files in the UI from agent runs.
-- [x] Add interaction sessions to a gallery.
-- [ ] Support for more complex agent workflows (e.g. `GroupChat` workflows).
-- [ ] Improved user experience (e.g., streaming intermediate model output, better summarization of agent responses, etc).
-
 Project Structure:
 
 - _autogenstudio/_ code for the backend classes and web api (FastAPI)
@@ -97,32 +87,6 @@ AutoGen Studio also takes several parameters to customize the application:
 
 Now that you have AutoGen Studio installed and running, you are ready to explore its capabilities, including defining and modifying agent workflows, interacting with agents and sessions, and expanding agent skills.
 
-## Capabilities
-
-AutoGen Studio proposes some high-level concepts.
-
-**Agent Workflow**: An agent workflow is a specification of a set of agents that can work together to accomplish a task. The simplest version of this is a setup with two agents – a user proxy agent (that represents a user i.e. it compiles code and prints result) and an assistant that can address task requests (e.g., generating plans, writing code, evaluating responses, proposing error recovery steps, etc.). A more complex flow could be a group chat where even more agents work towards a solution.
-
-**Session**: A session refers to a period of continuous interaction or engagement with an agent workflow, typically characterized by a sequence of activities or operations aimed at achieving specific objectives. It includes the agent workflow configuration, the interactions between the user and the agents. A session can be “published” to a “gallery”.
-
-**Skills**: Skills are functions (e.g., Python functions) that describe how to solve a task. In general, a good skill has a descriptive name (e.g. `generate_images`), extensive docstrings and good defaults (e.g., writing out files to disk for persistence and reuse). You can add new skills AutoGen Studio app via the provided UI. At inference time, these skills are made available to the assistant agent as they address your tasks.
-
-## Example Usage
-
-Consider the following query.
-
-```
-Plot a chart of NVDA and TESLA stock price YTD. Save the result to a file named nvda_tesla.png
-```
-
-The agent workflow responds by _writing and executing code_ to create a python program to generate the chart with the stock prices.
-
-> Note than there could be multiple turns between the `AssistantAgent` and the `UserProxyAgent` to produce and execute the code in order to complete the task.
-
-![ARA](./docs/ara_stockprices.png)
-
-> Note: You can also view the debug console that generates useful information to see how the agents are interacting in the background.
-
 ## Contribution Guide
 
 We welcome contributions to AutoGen Studio. We recommend the following general steps to contribute to the project:
@@ -137,29 +101,7 @@ We welcome contributions to AutoGen Studio. We recommend the following general s
 
 ## FAQ
 
-**Q: How do I specify the directory where files(e.g. database) are stored?**
-
-A: You can specify the directory where files are stored by setting the `--appdir` argument when running the application. For example, `autogenstudio ui --appdir /path/to/folder`. This will store the database (default) and other files in the specified directory e.g. `/path/to/folder/database.sqlite`.
-
-**Q: Where can I adjust the default skills, agent and workflow configurations?**
-A: You can modify agent configurations directly from the UI or by editing the [dbdefaults.json](autogenstudio/utils/dbdefaults.json) file which is used to initialize the database.
-
-**Q: If I want to reset the entire conversation with an agent, how do I go about it?**
-A: To reset your conversation history, you can delete the `database.sqlite` file in the `--appdir` directory. This will reset the entire conversation history. To delete user files, you can delete the `files` directory in the `--appdir` directory.
-
-**Q: Is it possible to view the output and messages generated by the agents during interactions?**
-A: Yes, you can view the generated messages in the debug console of the web UI, providing insights into the agent interactions. Alternatively, you can inspect the `database.sqlite` file for a comprehensive record of messages.
-
-**Q: Can I use other models with AutoGen Studio?**
-Yes. AutoGen standardizes on the openai model api format, and you can use any api server that offers an openai compliant endpoint. In the AutoGen Studio UI, each agent has an `llm_config` field where you can input your model endpoint details including `model`, `api key`, `base url`, `model type` and `api version`. For Azure OpenAI models, you can find these details in the Azure portal. Note that for Azure OpenAI, the `model name` is the deployment id or engine, and the `model type` is "azure".
-For other OSS models, we recommend using a server such as vllm to instantiate an openai compliant endpoint.
-
-**Q: The server starts but I can't access the UI**
-A: If you are running the server on a remote machine (or a local machine that fails to resolve localhost correstly), you may need to specify the host address. By default, the host address is set to `localhost`. You can specify the host address using the `--host <host>` argument. For example, to start the server on port 8081 and local address such that it is accessible from other machines on the network, you can run the following command:
-
-```bash
-autogenstudio ui --port 8081 --host 0.0.0.0
-```
+Please refer to the AutoGen Studio [FAQs](https://microsoft.github.io/autogen/docs/autogen-studio/faqs) page for more information.
 
 ## Acknowledgements
 

website/blog/2023-12-01-AutoGenStudio/index.mdx

@@ -25,6 +25,9 @@ To help you rapidly prototype multi-agent solutions for your tasks, we are intro
 - Explicitly add skills to your agents and accomplish more tasks.
 - Publish your sessions to a local gallery.
 
+
+See the official AutoGen Studio documentation [here](https://microsoft.github.io/autogen/docs/autogen-studio/getting-started) for more details.
+
 AutoGen Studio is open source [code here](https://github.com/microsoft/autogen/tree/main/samples/apps/autogen-studio), and can be installed via pip. Give it a try!
 
 ```bash

website/docs/autogen-studio/faqs.md

@@ -0,0 +1,86 @@
+# AutoGen Studio FAQs
+
+## Q: How do I specify the directory where files(e.g. database) are stored?
+
+A: You can specify the directory where files are stored by setting the `--appdir` argument when running the application. For example, `autogenstudio ui --appdir /path/to/folder`. This will store the database (default) and other files in the specified directory e.g. `/path/to/folder/database.sqlite`.
+
+## Q: Where can I adjust the default skills, agent and workflow configurations?
+
+A: You can modify agent configurations directly from the UI or by editing the `init_db_samples` function in the `autogenstudio/database/utils.py` file which is used to initialize the database.
+
+## Q: If I want to reset the entire conversation with an agent, how do I go about it?
+
+A: To reset your conversation history, you can delete the `database.sqlite` file in the `--appdir` directory. This will reset the entire conversation history. To delete user files, you can delete the `files` directory in the `--appdir` directory.
+
+## Q: Is it possible to view the output and messages generated by the agents during interactions?
+
+A: Yes, you can view the generated messages in the debug console of the web UI, providing insights into the agent interactions. Alternatively, you can inspect the `database.sqlite` file for a comprehensive record of messages.
+
+## Q: Can I use other models with AutoGen Studio?
+
+Yes. AutoGen standardizes on the openai model api format, and you can use any api server that offers an openai compliant endpoint. In the AutoGen Studio UI, each agent has an `llm_config` field where you can input your model endpoint details including `model`, `api key`, `base url`, `model type` and `api version`. For Azure OpenAI models, you can find these details in the Azure portal. Note that for Azure OpenAI, the `model name` is the deployment id or engine, and the `model type` is "azure".
+For other OSS models, we recommend using a server such as vllm, LMStudio, Ollama, to instantiate an openai compliant endpoint.
+
+## Q: The server starts but I can't access the UI
+
+A: If you are running the server on a remote machine (or a local machine that fails to resolve localhost correctly), you may need to specify the host address. By default, the host address is set to `localhost`. You can specify the host address using the `--host <host>` argument. For example, to start the server on port 8081 and local address such that it is accessible from other machines on the network, you can run the following command:
+
+```bash
+autogenstudio ui --port 8081 --host 0.0.0.0
+```
+
+## Q: Can I export my agent workflows for use in a python app?
+
+Yes. In the Build view, you can click the export button to save your agent workflow as a JSON file. This file can be imported in a python application using the `WorkflowManager` class. For example:
+
+```python
+
+from autogenstudio import WorkflowManager
+# load workflow from exported json workflow file.
+workflow_manager = WorkflowManager(workflow="path/to/your/workflow_.json")
+
+# run the workflow on a task
+task_query = "What is the height of the Eiffel Tower?. Dont write code, just respond to the question."
+workflow_manager.run(message=task_query)
+
+```
+
+## Q: Can I deploy my agent workflows as APIs?
+
+Yes. You can launch the workflow as an API endpoint from the command line using the `autogenstudio` commandline tool. For example:
+
+```bash
+autogenstudio serve --workflow=workflow.json --port=5000
+```
+
+Similarly, the workflow launch command above can be wrapped into a Dockerfile that can be deployed on cloud services like Azure Container Apps or Azure Web Apps.
+
+## Q: Can I run AutoGen Studio in a Docker container?
+
+A: Yes, you can run AutoGen Studio in a Docker container. You can build the Docker image using the provided [Dockerfile](https://github.com/microsoft/autogen/blob/autogenstudio/samples/apps/autogen-studio/Dockerfile) and run the container using the following commands:
+
+```bash
+FROM python:3.10
+
+WORKDIR /code
+
+RUN pip install -U gunicorn autogenstudio
+
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH \
+    AUTOGENSTUDIO_APPDIR=/home/user/app
+
+WORKDIR $HOME/app
+
+COPY --chown=user . $HOME/app
+
+CMD gunicorn -w $((2 * $(getconf _NPROCESSORS_ONLN) + 1)) --timeout 12600 -k uvicorn.workers.UvicornWorker autogenstudio.web.app:app --bind "0.0.0.0:8081"
+```
+
+Using Gunicorn as the application server for improved performance is recommended. To run AutoGen Studio with Gunicorn, you can use the following command:
+
+```bash
+gunicorn -w $((2 * $(getconf _NPROCESSORS_ONLN) + 1)) --timeout 12600 -k uvicorn.workers.UvicornWorker autogenstudio.web.app:app --bind
+```