Skip to content

Commit

Permalink
Modify format accordingly.
Browse files Browse the repository at this point in the history
  • Loading branch information
DavdGao committed Feb 19, 2024
1 parent 0613d06 commit bc030aa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions docs/sphinx_doc/source/tutorial/105-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ logger.error("The agent encountered an unexpected error while processing a reque

## Integrating logging with WebUI

To visualize these logs and running details, AgentScope provides a simple
web interface.
To visualize these logs and running details, AgentScope provides a simple
web interface.

### Quick Running

Expand All @@ -84,12 +84,12 @@ By this way, you can see all the running instances and projects in `http://127.

![webui](https://img.alicdn.com/imgextra/i3/O1CN01kpHFkn1HpeYEkn60I_!!6000000000807-0-tps-3104-1849.jpg)

By clicking a running instance, we can observe more details.
By clicking a running instance, we can observe more details.

![The running details](https://img.alicdn.com/imgextra/i2/O1CN01AZtsf31MIHm4FmjjO_!!6000000001411-0-tps-3104-1849.jpg)

### Note
The WebUI is still under development. We will provide more features and
The WebUI is still under development. We will provide more features and
better user experience in the future.

[[Return to the top]](#logging-and-webui)
14 changes: 7 additions & 7 deletions src/agentscope/web/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AgentScope Web UI

A user interface for AgentScope, which is a tool for monitoring and
A user interface for AgentScope, which is a tool for monitoring and
analyzing the communication of agents in a multi-agent application.

## Quick Start
Expand All @@ -11,14 +11,14 @@ import agentscope

agentscope.web.init(
path_save="YOUR_SAVE_PATH",
host="YOUR_WEB_IP", # defaults to 127.0.0.1
host="YOUR_WEB_IP", # defaults to 127.0.0.1
port=5000 # defaults to 5000
)
```
The argument `path_save` refers to the saving directory of your application,
which defaults to `./runs` in AgentScope.
which defaults to `./runs` in AgentScope.

Note when running AgentScope applications, the argument `save_log` of
Note when running AgentScope applications, the argument `save_log` of
`agentscope.init` function should be `True` to enable saving the logging files.
```python
import agentscope
Expand All @@ -31,11 +31,11 @@ agentscope.init(
```
## A Running Example

The home page of web UI, which lists all available projects and runs in the
given saving path.
The home page of web UI, which lists all available projects and runs in the
given saving path.

![The web UI](https://img.alicdn.com/imgextra/i3/O1CN01kpHFkn1HpeYEkn60I_!!6000000000807-0-tps-3104-1849.jpg)

By clicking a running instance, we can observe more details.
By clicking a running instance, we can observe more details.

![The running details](https://img.alicdn.com/imgextra/i2/O1CN01AZtsf31MIHm4FmjjO_!!6000000001411-0-tps-3104-1849.jpg)

0 comments on commit bc030aa

Please sign in to comment.