Release v1.0.0

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2023-11-21
+
+### Added
+- Offical release of XAgent Container Images on DockerHub, now you can just download and play XAgent, see our dockerhub [page](https://hub.docker.com/u/xagentteam) for more information.
+- Localhost models [XAgentLlama-7B-preview](https://huggingface.co/XAgentTeam/XAgentLlama-7B-preview), [XAgentLlama-34B-preview](https://huggingface.co/XAgentTeam/XAgentLLaMa-34B-preview) developped for XAgent is now available on HuggingFace, click [here](https://huggingface.co/collections/XAgentTeam/xagentllm-655ae4091c419bb072940e74) to learn more.
+- **XAgentGen** is released to enhance the usability and stability of Localhost models for XAgent. Check out the [XAgentGen](XAgentGen/README.md) for more details.
+- **WebUI** is updated! Now you can browse files in workspace! **History replay** is also available now!
+- Mysql integration for data management, including runtime interactive data and running records.
+- Redis integration for managing the state of components during interaction processes.
+- Docker and initialization for Mysql and Redis included within the project setup.
+- New exception handling processes, with custom exception classes for different runtime errors.
+- Session sharing feature, allowing users to share their sessions with the community.
+
+### Changed
+
+- Removed some global variables, now using `XAgent.core.XAgentCoreComponents` for better modularity and encapsulation.
+- Overhauled the project structure of XAgentServer for improved organization and maintainability.
+
+### Removed
+
+- XAgentIO.
+- Local file storage mode and its support mechanisms.
+
+### Fixed
+
+- Fix various bugs in `XAgentServer` as reported in project issues.
+
+## [0.1.0] - 2023-10-16
+
+- Initial setup and integration of the `Toolserver`, `XAgent`, `XAgentIO`, `XAgentServer`, and `XAgentWeb` components.

README.md

@@ -77,15 +77,25 @@ You can also easily add new tools to ToolServer to enhance XAgent's abilities.
 
 ToolServer is where XAgent's action takes place. It is a docker container that provides a safe environment for XAgent to run.
 So you should install `docker` and `docker-compose` first. 
-After that, you should build the docker image for ToolServer and start the docker container.
+Then, you need to build the ToolServer image. In the `ToolServer` directory, you have two ways to build an image of our service:
+You can build a docker network by pulling the image from docker hub by running the following command:
 ```bash
-docker-compose up --build
+docker compose up
+```
+Or you can build an image from local sources by running the following command:
+```bash
+docker compose build
+docker compose up
 ```
 This will build the image for the ToolServer and start the ToolServer's container. 
-If you want to run the container in the background, please use `docker-compose up -d --build`.
+If you want to run the container in the background, please use `docker compose up -d`.
 Refer [here](ToolServer/README.md) for detailed information about our ToolServer.
 
-If the ToolServer is updated, you have to rebuild the images:
+If the ToolServer is updated, you have to repull/rebuild the images:
+```bash
+docker compose pull
+```
+Or
 ```bash
 docker compose build
 ```
@@ -127,14 +137,9 @@ python run.py --task "put your task here" --model "gpt-4" --config_file "assets/
 
 
 - Run XAgent with GUI
-```bash
-## We ran the web ui docker when building the ToolServer network
-## run nginx in docker
-docker exec XAgent-Server systemctl start nginx
-```
-Build the docker image for XAgent-Server and start the docker container.
-You will see the XAgent Server listening on port `8090`.
+The container `XAgent-Server` is started with nginx and a web server listening on port `5173`.
 You could visit `http://localhost:5173` to interact with XAgent by using web UI.
+The default username and password are `guest` and `xagent`, respectively.
 Refer [here](XAgentServer/README.md) for the detailed information about our GUI Demo.
 
 <div><a id="Demo"></a></div>

README_JA.md

@@ -76,16 +76,27 @@ ToolServer は、タスクを解決するための強力で安全なツールを
 
 ToolServer は、XAgent の動作が行われる場所です。これは、XAgent が実行するための安全な環境を提供する Docker コンテナになります。
 そのため、まず `docker` と `docker-compose` をインストールする必要があります。
-その後、ToolServer 用の docker イメージをビルドし、docker コンテナを起動します。
+次に、ToolServerイメージを構築する必要があります。 ToolServer`ディレクトリでは、私たちのサービスのイメージを構築する2つの方法があります：
+以下のコマンドを実行することで、docker hubからイメージを取得し、dockerネットワークを構築することができます：
 ```bash
-docker-compose up --build
+docker compose up
+```
+あるいは、以下のコマンドを実行してローカルソースからイメージを構築することもできます：
+バッシュ
+```bash
+docker compose build
+docker compose up
 ```
 これによりツールサーバーのイメージが構築され、ツールサーバーのコンテナが起動します。
-コンテナをバックグラウンドで実行したい場合は、`docker-compose up -d --build` を使用してください。
+コンテナをバックグラウンドで実行したい場合は、`docker compose up -d` を使用してください。
 ToolServer の詳細については、[こちら](ToolServer/README.md)を参照してください。
 
 ToolServer が更新された場合、イメージを再構築する必要があります:
 ```bash
+docker compose pull
+```
+Or
+```bash
 docker compose build
 ```
 
@@ -127,14 +138,9 @@ python run.py --task "put your task here" --model "gpt-4" --config_file "assets/
 
 
 - GUI で XAgent を実行する
-```bash
-## ToolServer ネットワークを構築する際に、Web ui docker を実行しました
-## docker で nginx を実行する
-docker exec XAgent-Server systemctl start nginx
-```
-XAgent-Server 用の docker イメージをビルドし、docker コンテナを起動します。
-ポート `8090` で XAgent Server がリッスンしているのが見えると思います。
-Web UI を使用して XAgent と対話するには、`http://localhost:5173` にアクセスしてください。
+コンテナ XAgent-Server は、nginxとポート 5173 でリッスンしているウェブサーバーと共に起動しています。
+Web UI を使用して XAgent とやり取りするには、http://localhost:5173 を訪れることができます。
+デフォルトのユーザー名とパスワードはそれぞれ guest と xagent です。
 GUI デモの詳細については、[こちら](XAgentServer/README.md) を参照してください。
 
 <div><a id="デモ"></a></div>