Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #75

Merged
merged 29 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
afd3096
update English README.md ad search.py doc-string
ZiTao-Li Mar 15, 2024
d344568
update model tutorial
ZiTao-Li Mar 15, 2024
5c77879
rename directories of examples
DavdGao Mar 17, 2024
6772c88
finish chinese readme.md
DavdGao Mar 17, 2024
09df544
add ollama related scripts
DavdGao Mar 18, 2024
3226f28
reformat
DavdGao Mar 18, 2024
bb44b72
reformat
DavdGao Mar 18, 2024
be90d6d
modified accordingly
DavdGao Mar 18, 2024
f9a44b8
update sphinx docs
pan-x-c Mar 18, 2024
0e617ad
Merge branch 'update_README' of github.com:ZiTao-Li/agentscope into z…
pan-x-c Mar 18, 2024
28bd79f
Merge branch 'main' into zt/update_readme
pan-x-c Mar 18, 2024
137bb36
improve accordingly
DavdGao Mar 18, 2024
8315608
Merge branch 'update_README_merge' into update_README
DavdGao Mar 18, 2024
697f424
reformat
DavdGao Mar 18, 2024
2b1c9f1
modified accordingly
DavdGao Mar 18, 2024
23e4481
update notebook example
pan-x-c Mar 18, 2024
b1b86af
update notebook example
pan-x-c Mar 18, 2024
34e7364
Merge branch 'modelscope:main' into update_README
ZiTao-Li Mar 18, 2024
6e13296
fix auto-discussion example
pan-x-c Mar 18, 2024
eee06fe
Merge branch 'update_README' of github.com:ZiTao-Li/agentscope into z…
pan-x-c Mar 18, 2024
228d26e
Adjust the order of tutorial
DavdGao Mar 18, 2024
4f69108
Merge branch 'update_README_merge' into update_README
DavdGao Mar 18, 2024
40129f1
update version
pan-x-c Mar 18, 2024
8655ac9
Merge branch 'update_README' of github.com:ZiTao-Li/agentscope into z…
pan-x-c Mar 18, 2024
3a5b136
improvement
DavdGao Mar 18, 2024
ab6d367
Merge branch 'backup' into update_README
DavdGao Mar 18, 2024
fda248d
reformat
DavdGao Mar 18, 2024
e1d7aa3
improve accordingly
DavdGao Mar 18, 2024
52bb077
improve accordingly
DavdGao Mar 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
387 changes: 159 additions & 228 deletions README.md

Large diffs are not rendered by default.

359 changes: 137 additions & 222 deletions README_ZH.md

Large diffs are not rendered by default.

18 changes: 8 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pip install sphinx sphinx-autobuild sphinx_rtd_theme myst-parser sphinxcontrib-m
cd sphinx_doc

# step 3: build the sphinx doc
make clean html
make clean all

# step 4: view sphinx_doc/build/html/index.html using your browser
```
Expand All @@ -32,14 +32,14 @@ src

If a new package (`agentscope/new_package`) is added , please add the corresponding documents as follows:

1. use the following script to generate template script (`sphinx_doc/source/agentscope.new_package.rst`) of new packages.
1. use the following script to generate template script (`sphinx_doc/{language}/source/agentscope.new_package.rst`) of new packages.

```shell
cd sphinx_doc
sphinx-apidoc -o source ../../src/agentscope
sphinx-apidoc -o {language}/source ../../src/agentscope
```

2. edit `sphinx_doc/source/agentscope.new_package.rst`, modify the content of the generated template script. For example, modify
2. edit `sphinx_doc/{language}/source/agentscope.new_package.rst`, modify the content of the generated template script. For example, modify

```
agentscope.new\_package package
Expand Down Expand Up @@ -68,7 +68,7 @@ new\_module module
...
```

1. modify the `sphinx_doc/source/index.rst`, add the new package into the table of contents.
3. modify the `sphinx_doc/{language}/source/index.rst`, add the new package into the table of contents.

```
.. toctree::
Expand All @@ -86,8 +86,7 @@ new\_module module
4. rebuild the sphinx doc of AgentScope

```
make clean
make html
make clean all
```

### Add doc for new modules
Expand All @@ -105,7 +104,7 @@ src

If a new module (agentscope/existing_package/new_module.py) is added , please add the corresponding documents as follows:

1. edit `sphinx_doc/source/agentscope.existing_package.rst` and add the following content.
1. edit `sphinx_doc/{language}/source/agentscope.existing_package.rst` and add the following content.

```
new\_module module
Expand All @@ -120,6 +119,5 @@ new\_module module
2. rebuild the sphinx doc of AgentScope

```
make clean
make html
make clean all
```
4 changes: 2 additions & 2 deletions docs/sphinx_doc/en/source/_templates/language_selector.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- language_selector.html -->
<div class="language-selector">
<a href="{{ pathto('../en/index') }}">English</a></li> |
<a href="{{ pathto('../zh_CN/index') }}">中文</a></li>
<a href="{{ pathto('../en/' + pagename) }}">English</a></li> |
<a href="{{ pathto('../zh_CN/' + pagename) }}">中文</a></li>
</div>
2 changes: 1 addition & 1 deletion docs/sphinx_doc/en/source/tutorial/202-pipeline.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(202-pipeline-en)=

# Agent Interactions: Dive deeper into Pipelines and Message Hub
# Pipeline and MsgHub

**Pipeline & MsgHub** (message hub) are one or a sequence of steps describing how the structured `Msg` passes between multi-agents, which streamlines the process of collaboration across agents.

Expand Down
Loading
Loading