Upload 188 files

.gitattributes

@@ -1,35 +1,47 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*.tfevents* filter=lfs diff=lfs merge=lfs -text
+*.db* filter=lfs diff=lfs merge=lfs -text
+*.ark* filter=lfs diff=lfs merge=lfs -text
+**/*ckpt*data* filter=lfs diff=lfs merge=lfs -text
+**/*ckpt*.meta filter=lfs diff=lfs merge=lfs -text
+**/*ckpt*.index filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.gguf* filter=lfs diff=lfs merge=lfs -text
+*.ggml filter=lfs diff=lfs merge=lfs -text
+*.llamafile* filter=lfs diff=lfs merge=lfs -text
+*.pt2 filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.ipynb_checkpoints/app-checkpoint.py

@@ -0,0 +1,30 @@
+import streamlit as st
+import os
+import runpy
+st.set_page_config(layout="wide", page_title="My Multi-Page App")
+def set_env_variable(key, value):
+    os.environ[key] = value
+def home_page():
+    st.header("欢迎来到首页")
+    # 设置输入框为隐私状态
+    token = st.text_input("请输入浦语token:", type="password", key="token")
+    weather_token = st.text_input("请输入和风天气token:", type="password", key="weather_token")
+    if st.button("保存并体验agent"):
+        if token and weather_token:
+            set_env_variable("token", token)  # 设置环境变量为 'token'
+            set_env_variable("weather_token", weather_token)  # 设置环境变量为 'weather_token'
+            st.session_state.token_entered = True
+            st.rerun()
+        else:
+            st.error("请输入所有token")
+if 'token_entered' not in st.session_state:
+    st.session_state.token_entered = False
+if not st.session_state.token_entered:
+    home_page()
+else:
+    # 动态加载子页面
+    page = st.sidebar.radio("选择页面", ["天气查询助手", "博客写作助手"])
+    if page == "天气查询助手":
+        runpy.run_path("examples/agent_api_web_demo.py", run_name="__main__")
+    elif page == "博客写作助手":
+        runpy.run_path("examples/multi_agents_api_web_demo.py", run_name="__main__")

.ipynb_checkpoints/requirements-checkpoint.txt

@@ -0,0 +1,50 @@
+-r requirements/optional.txt
+-r requirements/runtime.txt
+
+torch==2.1.2
+torchvision==0.16.2
+torchaudio==2.1.2
+termcolor==2.4.0
+streamlit==1.39.0
+class_registry==2.1.2
+datasets==3.1.0
+griffe==0.48.0
+
+torch==2.1.2
+torchvision==0.16.2
+torchaudio==2.1.2
+termcolor==2.4.0
+streamlit==1.39.0
+class_registry==2.1.2
+datasets==3.1.0
+# -r requirements/optional.txt
+google-search-results
+lmdeploy>=0.2.5
+pillow
+python-pptx
+timeout_decorator
+torch
+transformers>=4.34,<=4.40
+vllm>=0.3.3
+# -r requirements/runtime.txt
+aiohttp
+arxiv
+asyncache
+asyncer
+distro
+duckduckgo_search==5.3.1b1
+filelock
+func_timeout
+griffe<1.0
+json5
+jsonschema
+jupyter==1.0.0
+jupyter_client==8.6.2
+jupyter_core==5.7.2
+pydantic==2.6.4
+requests
+termcolor
+tiktoken
+timeout-decorator
+typing-extensions
+griffe==0.48.0

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+exclude: ^(tests/data|scripts|ftdp/protocols|ftdp/template_configs|ftdp/tool_dicts)/
+repos:
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+      - id: black
+        args: ["--line-length", "119", "--skip-string-normalization"]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: requirements-txt-fixer
+      - id: double-quote-string-fixer
+      - id: check-merge-conflict
+      - id: fix-encoding-pragma
+        args: ["--remove"]
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.17
+    hooks:
+      - id: mdformat
+        args: ["--number"]
+        additional_dependencies:
+          - mdformat-openmmlab
+          - mdformat_frontmatter
+          - linkify-it-py
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py36-plus"]

.pylintrc

@@ -0,0 +1,428 @@
+# This Pylint rcfile contains a best-effort configuration to uphold the
+# best-practices and style described in the Google Python style guide:
+#   https://google.github.io/styleguide/pyguide.html
+#
+# Its canonical open-source location is:
+#   https://google.github.io/styleguide/pylintrc
+
+[MASTER]
+
+# Files or directories to be skipped. They should be base names, not paths.
+ignore=third_party,storage
+
+# Files or directories matching the regex patterns are skipped. The regex
+# matches against base names, not paths.
+ignore-patterns=
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Use multiple processes to speed up Pylint.
+jobs=4
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+#enable=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+disable=abstract-method,
+        apply-builtin,
+        arguments-differ,
+        attribute-defined-outside-init,
+        backtick,
+        bad-option-value,
+        basestring-builtin,
+        buffer-builtin,
+        c-extension-no-member,
+        consider-using-enumerate,
+        cmp-builtin,
+        cmp-method,
+        coerce-builtin,
+        coerce-method,
+        delslice-method,
+        div-method,
+        duplicate-code,
+        eq-without-hash,
+        execfile-builtin,
+        file-builtin,
+        filter-builtin-not-iterating,
+        fixme,
+        getslice-method,
+        global-statement,
+        hex-method,
+        idiv-method,
+        implicit-str-concat,
+        import-error,
+        import-self,
+        import-star-module-level,
+        inconsistent-return-statements,
+        input-builtin,
+        intern-builtin,
+        invalid-str-codec,
+        locally-disabled,
+        long-builtin,
+        long-suffix,
+        map-builtin-not-iterating,
+        misplaced-comparison-constant,
+        missing-function-docstring,
+        metaclass-assignment,
+        next-method-called,
+        next-method-defined,
+        no-absolute-import,
+        no-else-break,
+        no-else-continue,
+        no-else-raise,
+        no-else-return,
+        no-init,  # added
+        no-member,
+        no-name-in-module,
+        no-self-use,
+        nonzero-method,
+        oct-method,
+        old-division,
+        old-ne-operator,
+        old-octal-literal,
+        old-raise-syntax,
+        parameter-unpacking,
+        print-statement,
+        raising-string,
+        range-builtin-not-iterating,
+        raw_input-builtin,
+        rdiv-method,
+        reduce-builtin,
+        relative-import,
+        reload-builtin,
+        round-builtin,
+        setslice-method,
+        signature-differs,
+        standarderror-builtin,
+        suppressed-message,
+        sys-max-int,
+        too-few-public-methods,
+        too-many-ancestors,
+        too-many-arguments,
+        too-many-boolean-expressions,
+        too-many-branches,
+        too-many-instance-attributes,
+        too-many-locals,
+        too-many-nested-blocks,
+        too-many-public-methods,
+        too-many-return-statements,
+        too-many-statements,
+        trailing-newlines,
+        unichr-builtin,
+        unicode-builtin,
+        unnecessary-pass,
+        unpacking-in-except,
+        useless-else-on-loop,
+        useless-object-inheritance,
+        useless-suppression,
+        using-cmp-argument,
+        wrong-import-order,
+        xrange-builtin,
+        zip-builtin-not-iterating,
+
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=colorized
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details
+#msg-template=
+
+
+[BASIC]
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=main,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Include a hint for the correct naming format with invalid-name
+include-naming-hint=no
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl
+
+# Regular expression matching correct function names
+function-rgx=^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$
+
+# Regular expression matching correct variable names
+variable-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct constant names
+const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression matching correct attribute names
+attr-rgx=^_{0,2}[a-z][a-z0-9_]*$
+
+# Regular expression matching correct argument names
+argument-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct class attribute names
+class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression matching correct inline iteration names
+inlinevar-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct class names
+class-rgx=^_?[A-Z][a-zA-Z0-9]*$
+
+# Regular expression matching correct module names
+module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$
+
+# Regular expression matching correct method names
+method-rgx=(?x)^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=10
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt
+# lines made too long by directives to pytype.
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=(?x)(
+  ^\s*(\#\ )?<?https?://\S+>?$|
+  ^\s*(from\s+\S+\s+)?import\s+.+$)
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=yes
+
+# Maximum number of lines in a module
+max-module-lines=99999
+
+# String used as indentation unit.  The internal Google style guide mandates 2
+# spaces.  Google's externaly-published style guide says 4, consistent with
+# PEP 8.  Here, we use 2 spaces, for conformity with many open-sourced Google
+# projects (like TensorFlow).
+indent-string='    '
+
+# Number of spaces of indent required inside a hanging  or continued line.
+indent-after-paren=4
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=TODO
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=yes
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the name of dummy variables (i.e. expectedly
+# not used).
+dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_)
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,_cb
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging,absl.logging,tensorflow.io.logging
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[SPELLING]
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,
+                   TERMIOS,
+                   Bastion,
+                   rexec,
+                   sets
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant, absl
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+                  _fields,
+                  _replace,
+                  _source,
+                  _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls,
+                            class_
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+formats: all
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: requirements/docs.txt
+
+sphinx:
+  configuration: docs/en/conf.py

MANIFEST.in

@@ -0,0 +1 @@
+include requirements/*.txt

app.py

@@ -1 +1,30 @@
-111
+import streamlit as st
+import os
+import runpy
+st.set_page_config(layout="wide", page_title="My Multi-Page App")
+def set_env_variable(key, value):
+    os.environ[key] = value
+def home_page():
+    st.header("欢迎来到首页")
+    # 设置输入框为隐私状态
+    token = st.text_input("请输入浦语token:", type="password", key="token")
+    weather_token = st.text_input("请输入和风天气token:", type="password", key="weather_token")
+    if st.button("保存并体验agent"):
+        if token and weather_token:
+            set_env_variable("token", token)  # 设置环境变量为 'token'
+            set_env_variable("weather_token", weather_token)  # 设置环境变量为 'weather_token'
+            st.session_state.token_entered = True
+            st.rerun()
+        else:
+            st.error("请输入所有token")
+if 'token_entered' not in st.session_state:
+    st.session_state.token_entered = False
+if not st.session_state.token_entered:
+    home_page()
+else:
+    # 动态加载子页面
+    page = st.sidebar.radio("选择页面", ["天气查询助手", "博客写作助手"])
+    if page == "天气查询助手":
+        runpy.run_path("examples/agent_api_web_demo.py", run_name="__main__")
+    elif page == "博客写作助手":
+        runpy.run_path("examples/multi_agents_api_web_demo.py", run_name="__main__")

docs/en/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/en/_static/css/readthedocs.css

@@ -0,0 +1,6 @@
+.header-logo {
+    background-image: url("../images/lagent_icon.png");
+    background-size: 40px 40px;
+    height: 40px;
+    width: 40px;
+}

docs/en/_static/js/collapsed.js

@@ -0,0 +1 @@
+var collapsedSections = ['API Reference']

docs/en/_static/js/table.js

@@ -0,0 +1,31 @@
+$(document).ready(function () {
+    table = $('.model-summary').DataTable({
+        "stateSave": false,
+        "lengthChange": false,
+        "pageLength": 10,
+        "order": [],
+        "scrollX": true,
+        "columnDefs": [
+            { "type": "summary", targets: '_all' },
+        ]
+    });
+    // Override the default sorting for the summary columns, which
+    // never takes the "-" character into account.
+    jQuery.extend(jQuery.fn.dataTableExt.oSort, {
+        "summary-asc": function (str1, str2) {
+            if (str1 == "<p>-</p>")
+                return 1;
+            if (str2 == "<p>-</p>")
+                return -1;
+            return ((str1 < str2) ? -1 : ((str1 > str2) ? 1 : 0));
+        },
+
+        "summary-desc": function (str1, str2) {
+            if (str1 == "<p>-</p>")
+                return 1;
+            if (str2 == "<p>-</p>")
+                return -1;
+            return ((str1 < str2) ? 1 : ((str1 > str2) ? -1 : 0));
+        }
+    });
+})

docs/en/_templates/autoapi/index.rst

@@ -0,0 +1,14 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation.
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   {% for page in pages %}
+   {% if page.top_level_object and page.display %}
+   {{ page.include_path }}
+   {% endif %}
+   {% endfor %}

docs/en/_templates/autoapi/python/module.rst

@@ -0,0 +1,112 @@
+{% if not obj.display %}
+:orphan:
+
+{% endif %}
+:py:mod:`{{ obj.name if obj.name.count(".") <= 1 else obj.short_name }}`
+=========={{ "=" * (obj.name|length if obj.name.count(".") <= 1 else obj.short_name|length) }}
+
+.. py:module:: {{ obj.name }}
+
+{% if obj.docstring %}
+.. autoapi-nested-parse::
+
+   {{ obj.docstring|indent(3) }}
+
+{% endif %}
+
+{% block subpackages %}
+{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
+{% if visible_subpackages %}
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+{% for subpackage in visible_subpackages %}
+   {{ subpackage.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block submodules %}
+{% set visible_submodules = obj.submodules|selectattr("display")|list %}
+{% if visible_submodules %}
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+{% for submodule in visible_submodules %}
+   {{ submodule.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block content %}
+{% if obj.type is equalto("package") %}
+{% set visible_children = obj.children|selectattr("display")|list %}
+{% else %}
+{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
+{% endif %}
+{% if visible_children %}
+{{ obj.type|title }} Contents
+{{ "-" * obj.type|length }}---------
+
+{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
+{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
+{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}
+{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
+{% block classes scoped %}
+{% if visible_classes %}
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+{% for klass in visible_classes %}
+   {{ klass.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block functions scoped %}
+{% if visible_functions %}
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+{% for function in visible_functions %}
+   {{ function.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block attributes scoped %}
+{% if visible_attributes %}
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+{% for attribute in visible_attributes %}
+   {{ attribute.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% endif %}
+{% for obj_item in visible_children %}
+{{ obj_item.render()|indent(0) }}
+{% endfor %}
+{% endif %}
+{% endblock %}

docs/en/_templates/classtemplate.rst

@@ -0,0 +1,14 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:
+
+
+..
+  autogenerated from source/_templates/classtemplate.rst
+  note it does not have :inherited-members:

docs/en/changelog.md

@@ -0,0 +1,16 @@
+## Changelog
+
+### v0.1.2 (24/10/2023)
+
+#### Highlights
+
+- Support Efficient Inference Engine [lmdeploy turbomind](https://github.com/InternLM/lmdeploy/tree/main)
+
+#### New Features
+
+- Support Efficient Inference Engine [TurboMind](https://github.com/InternLM/lmdeploy/tree/main): Based on lmdeploy turbomind, Lagent supports the inference of LLaMA and its variant models on NVIDIA GPUs. (#47)
+
+#### Contributors
+
+A total of 2 developers contributed to this release.
+Thanks @Harold-lkk @jiangningliu30

docs/en/conf.py

@@ -0,0 +1,108 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import re
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information -----------------------------------------------------
+project = 'Lagent'
+copyright = '2020-2030, InternLM'
+author = 'InternLM'
+language = 'en'
+
+# The full version, including alpha/beta/rc tags
+version_file = '../../lagent/version.py'
+with open(version_file) as f:
+    exec(compile(f.read(), version_file, 'exec'))
+__version__ = locals()['__version__']
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx_rtd_theme',
+    'myst_nb',
+    'autoapi.extension',
+    'sphinx_markdown_tables',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+]
+
+nb_output_stderr = 'remove-warn'
+autodoc_typehints = 'description'
+
+# sphinx-autoapi configuration
+autoapi_dirs = ['../../lagent']
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+    'show-module-summary',
+]
+autoapi_ignore = ['*migrations*', '*command.py', '*cli.py']
+autoapi_template_dir = '_templates/autoapi'
+autoapi_add_toctree_entry = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    'navigation_depth': 3,
+    'titles_only': False,
+    'style_nav_header_background': '#4fabab',
+}
+html_context = {
+    'display_github': True,
+    'github_host': 'github.com',
+    'github_user': 'InternLM',
+    'github_repo': 'lagent',
+    'github_version': 'main',
+    'conf_py_path': '/docs/en/',
+}
+html_title = 'Lagent'
+html_logo = '../imgs/lagent_logo.png'
+html_favicon = '../imgs/lagent_icon.png'
+
+master_doc = 'index'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named 'default.css' will overwrite the builtin 'default.css'.
+html_static_path = ['_static']
+
+
+def custom_skip(app, what, name, obj, skip, options):
+    if what in ['data', 'function', 'class'] and re.search('logger', name):
+        skip = True
+    return skip
+
+
+def setup(sphinx):
+    sphinx.connect('autoapi-skip-member', custom_skip)

docs/en/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table_style: colwidths-auto

docs/en/get_started/install.md

@@ -0,0 +1,19 @@
+# Installation
+
+## With pip
+
+Install with pip (Recommended).
+
+```bash
+pip install lagent
+```
+
+## From source
+
+Optionally, you could also build Lagent from source in case you want to modify the code:
+
+```bash
+git clone https://github.com/InternLM/lagent.git
+cd lagent
+pip install -e .
+```

docs/en/get_started/quickstart.md

@@ -0,0 +1,485 @@
+# How to Use Lagent
+
+Lagent v1.0 is inspired by the design philosophy of PyTorch. We expect that the analogy of neural network layers will make the workflow clearer and more intuitive, so users only need to focus on creating layers and defining message passing between them in a Pythonic way. This is a simple tutorial to get you quickly started with building multi-agent applications.
+
+## Core Ideas
+
+### Models as Agents
+
+Agents use `AgentMessage` for communication.
+
+```python
+from typing import Dict, List
+from lagent.agents import Agent
+from lagent.schema import AgentMessage
+from lagent.llms import VllmModel, INTERNLM2_META
+
+llm = VllmModel(
+    path='Qwen/Qwen2-7B-Instruct',
+    meta_template=INTERNLM2_META,
+    tp=1,
+    top_k=1,
+    temperature=1.0,
+    stop_words=['<|im_end|>'],
+    max_new_tokens=1024,
+)
+system_prompt = '你的回答只能从“典”、“孝”、“急”三个字中选一个。'
+agent = Agent(llm, system_prompt)
+
+user_msg = AgentMessage(sender='user', content='今天天气情况')
+bot_msg = agent(user_msg)
+print(bot_msg)
+```
+
+```
+content='急' sender='Agent' formatted=None extra_info=None type=None receiver=None stream_state=<AgentStatusCode.END: 0>
+```
+
+### Memory as State
+
+Both input and output messages will be added to the memory of `Agent` in each forward pass. This is performed in `__call__` rather than `forward`. See the following pseudo code
+
+```python
+    def __call__(self, *message):
+        message = pre_hooks(message)
+        add_memory(message)
+        message = self.forward(*message)
+        add_memory(message)
+        message = post_hooks(message)
+        return message
+```
+
+Inspect the memory in two ways
+
+```python
+memory: List[AgentMessage] = agent.memory.get_memory()
+print(memory)
+print('-' * 120)
+dumped_memory: Dict[str, List[dict]] = agent.state_dict()
+print(dumped_memory['memory'])
+```
+
+```
+[AgentMessage(content='今天天气情况', sender='user', formatted=None, extra_info=None, type=None, receiver=None, stream_state=<AgentStatusCode.END: 0>), AgentMessage(content='急', sender='Agent', formatted=None, extra_info=None, type=None, receiver=None, stream_state=<AgentStatusCode.END: 0>)]
+------------------------------------------------------------------------------------------------------------------------
+[{'content': '今天天气情况', 'sender': 'user', 'formatted': None, 'extra_info': None, 'type': None, 'receiver': None, 'stream_state': <AgentStatusCode.END: 0>}, {'content': '急', 'sender': 'Agent', 'formatted': None, 'extra_info': None, 'type': None, 'receiver': None, 'stream_state': <AgentStatusCode.END: 0>}]
+```
+
+Clear the memory of this session(`session_id=0` by default):
+
+```python
+agent.memory.reset()
+```
+
+### Custom Message Aggregation
+
+`DefaultAggregator` is called under the hood to assemble and convert `AgentMessage` to OpenAI message format.
+
+```python
+    def forward(self, *message: AgentMessage, session_id=0, **kwargs) -> Union[AgentMessage, str]:
+        formatted_messages = self.aggregator.aggregate(
+            self.memory.get(session_id),
+            self.name,
+            self.output_format,
+            self.template,
+        )
+        llm_response = self.llm.chat(formatted_messages, **kwargs)
+        ...
+```
+
+Implement a simple aggregator that can receive few-shots
+
+```python
+from typing import List, Union
+from lagent.memory import Memory
+from lagent.prompts import StrParser
+from lagent.agents.aggregator import DefaultAggregator
+
+class FewshotAggregator(DefaultAggregator):
+    def __init__(self, few_shot: List[dict] = None):
+        self.few_shot = few_shot or []
+
+    def aggregate(self,
+                  messages: Memory,
+                  name: str,
+                  parser: StrParser = None,
+                  system_instruction: Union[str, dict, List[dict]] = None) -> List[dict]:
+        _message = []
+        if system_instruction:
+            _message.extend(
+                self.aggregate_system_intruction(system_instruction))
+        _message.extend(self.few_shot)
+        messages = messages.get_memory()
+        for message in messages:
+            if message.sender == name:
+                _message.append(
+                    dict(role='assistant', content=str(message.content)))
+            else:
+                user_message = message.content
+                if len(_message) > 0 and _message[-1]['role'] == 'user':
+                    _message[-1]['content'] += user_message
+                else:
+                    _message.append(dict(role='user', content=user_message))
+        return _message
+
+agent = Agent(
+    llm,
+    aggregator=FewshotAggregator(
+        [
+            {"role": "user", "content": "今天天气"},
+            {"role": "assistant", "content": "【晴】"},
+        ]
+    )
+)
+user_msg = AgentMessage(sender='user', content='昨天天气')
+bot_msg = agent(user_msg)
+print(bot_msg)
+```
+
+```
+content='【多云转晴，夜间有轻微降温】' sender='Agent' formatted=None extra_info=None type=None receiver=None stream_state=<AgentStatusCode.END: 0>
+```
+
+### Flexible Response Formatting
+
+In `AgentMessage`, `formatted` is reserved to store information parsed by `output_format` from the model output.
+
+```python
+    def forward(self, *message: AgentMessage, session_id=0, **kwargs) -> Union[AgentMessage, str]:
+        ...
+        llm_response = self.llm.chat(formatted_messages, **kwargs)
+        if self.output_format:
+            formatted_messages = self.output_format.parse_response(llm_response)
+            return AgentMessage(
+                sender=self.name,
+                content=llm_response,
+                formatted=formatted_messages,
+            )
+        ...
+```
+
+Use a tool parser as follows
+
+````python
+from lagent.prompts.parsers import ToolParser
+
+system_prompt = "逐步分析并编写Python代码解决以下问题。"
+parser = ToolParser(tool_type='code interpreter', begin='```python\n', end='\n```\n')
+llm.gen_params['stop_words'].append('\n```\n')
+agent = Agent(llm, system_prompt, output_format=parser)
+
+user_msg = AgentMessage(
+    sender='user',
+    content='Marie is thinking of a multiple of 63, while Jay is thinking of a '
+    'factor of 63. They happen to be thinking of the same number. There are '
+    'two possibilities for the number that each of them is thinking of, one '
+    'positive and one negative. Find the product of these two numbers.')
+bot_msg = agent(user_msg)
+print(bot_msg.model_dump_json(indent=4))
+````
+
+````
+{
+    "content": "首先，我们需要找出63的所有正因数和负因数。63的正因数可以通过分解63的质因数来找出，即\\(63 = 3^2 \\times 7\\)。因此，63的正因数包括1, 3, 7, 9, 21, 和 63。对于负因数，我们只需将上述正因数乘以-1。\n\n接下来，我们需要找出与63的正因数相乘的结果为63的数，以及与63的负因数相乘的结果为63的数。这可以通过将63除以每个正因数和负因数来实现。\n\n最后，我们将找到的两个数相乘得到最终答案。\n\n下面是Python代码实现：\n\n```python\ndef find_numbers():\n    # 正因数\n    positive_factors = [1, 3, 7, 9, 21, 63]\n    # 负因数\n    negative_factors = [-1, -3, -7, -9, -21, -63]\n    \n    # 找到与正因数相乘的结果为63的数\n    positive_numbers = [63 / factor for factor in positive_factors]\n    # 找到与负因数相乘的结果为63的数\n    negative_numbers = [-63 / factor for factor in negative_factors]\n    \n    # 计算两个数的乘积\n    product = positive_numbers[0] * negative_numbers[0]\n    \n    return product\n\nresult = find_numbers()\nprint(result)",
+    "sender": "Agent",
+    "formatted": {
+        "tool_type": "code interpreter",
+        "thought": "首先，我们需要找出63的所有正因数和负因数。63的正因数可以通过分解63的质因数来找出，即\\(63 = 3^2 \\times 7\\)。因此，63的正因数包括1, 3, 7, 9, 21, 和 63。对于负因数，我们只需将上述正因数乘以-1。\n\n接下来，我们需要找出与63的正因数相乘的结果为63的数，以及与63的负因数相乘的结果为63的数。这可以通过将63除以每个正因数和负因数来实现。\n\n最后，我们将找到的两个数相乘得到最终答案。\n\n下面是Python代码实现：\n\n",
+        "action": "def find_numbers():\n    # 正因数\n    positive_factors = [1, 3, 7, 9, 21, 63]\n    # 负因数\n    negative_factors = [-1, -3, -7, -9, -21, -63]\n    \n    # 找到与正因数相乘的结果为63的数\n    positive_numbers = [63 / factor for factor in positive_factors]\n    # 找到与负因数相乘的结果为63的数\n    negative_numbers = [-63 / factor for factor in negative_factors]\n    \n    # 计算两个数的乘积\n    product = positive_numbers[0] * negative_numbers[0]\n    \n    return product\n\nresult = find_numbers()\nprint(result)",
+        "status": 1
+    },
+    "extra_info": null,
+    "type": null,
+    "receiver": null,
+    "stream_state": 0
+}
+````
+
+### Consistency of Tool Calling
+
+`ActionExecutor` uses the same communication data structure as `Agent`, but requires the content of input `AgentMessage` to be a dict containing:
+
+- `name`: tool name, e.g. `'IPythonInterpreter'`, `'WebBrowser.search'`.
+- `parameters`: keyword arguments of the tool API, e.g. `{'command': 'import math;math.sqrt(2)'}`, `{'query': ['recent progress in AI']}`.
+
+You can register custom hooks for message conversion.
+
+```python
+from lagent.hooks import Hook
+from lagent.schema import ActionReturn, ActionStatusCode, AgentMessage
+from lagent.actions import ActionExecutor, IPythonInteractive
+
+class CodeProcessor(Hook):
+    def before_action(self, executor, message, session_id):
+        message = message.copy(deep=True)
+        message.content = dict(
+            name='IPythonInteractive', parameters={'command': message.formatted['action']}
+        )
+        return message
+
+    def after_action(self, executor, message, session_id):
+        action_return = message.content
+        if isinstance(action_return, ActionReturn):
+            if action_return.state == ActionStatusCode.SUCCESS:
+                response = action_return.format_result()
+            else:
+                response = action_return.errmsg
+        else:
+            response = action_return
+        message.content = response
+        return message
+
+executor = ActionExecutor(actions=[IPythonInteractive()], hooks=[CodeProcessor()])
+bot_msg = AgentMessage(
+    sender='Agent',
+    content='首先，我们需要...',
+    formatted={
+        'tool_type': 'code interpreter',
+        'thought': '首先，我们需要...',
+        'action': 'def find_numbers():\n    # 正因数\n    positive_factors = [1, 3, 7, 9, 21, 63]\n    # 负因数\n    negative_factors = [-1, -3, -7, -9, -21, -63]\n    \n    # 找到与正因数相乘的结果为63的数\n    positive_numbers = [63 / factor for factor in positive_factors]\n    # 找到与负因数相乘的结果为63的数\n    negative_numbers = [-63 / factor for factor in negative_factors]\n    \n    # 计算两个数的乘积\n    product = positive_numbers[0] * negative_numbers[0]\n    \n    return product\n\nresult = find_numbers()\nprint(result)',
+        'status': 1
+    })
+executor_msg = executor(bot_msg)
+print(executor_msg)
+```
+
+```
+content='3969.0' sender='ActionExecutor' formatted=None extra_info=None type=None receiver=None stream_state=<AgentStatusCode.END: 0>
+```
+
+**For convenience, Lagent provides `InternLMActionProcessor` which is adapted to messages formatted by `ToolParser` as mentioned above.**
+
+### Dual Interfaces
+
+Lagent adopts dual interface design, where almost every component(LLMs, actions, action executors...) has the corresponding asynchronous variant by prefixing its identifier with 'Async'. It is recommended to use synchronous agents for debugging and asynchronous ones for large-scale inference to make the most of idle CPU and GPU resources.
+
+However, make sure the internal consistency of agents, i.e. asynchronous agents should be equipped with asynchronous LLMs and asynchronous action executors that drive asynchronous tools.
+
+```python
+from lagent.llms import VllmModel, AsyncVllmModel, LMDeployPipeline, AsyncLMDeployPipeline
+from lagent.actions import ActionExecutor, AsyncActionExecutor, WebBrowser, AsyncWebBrowser
+from lagent.agents import Agent, AsyncAgent, AgentForInternLM, AsyncAgentForInternLM
+```
+
+______________________________________________________________________
+
+## Practice
+
+- **Try to implement `forward` instead of `__call__` of subclasses unless necessary.**
+- **Always include the `session_id` argument explicitly, which is designed for isolation of memory, LLM requests and tool invocation(e.g. maintain multiple independent IPython environments) in concurrency.**
+
+### Single Agent
+
+Math agents that solve problems by programming
+
+````python
+from lagent.agents.aggregator import InternLMToolAggregator
+
+class Coder(Agent):
+    def __init__(self, model_path, system_prompt, max_turn=3):
+        super().__init__()
+        llm = VllmModel(
+            path=model_path,
+            meta_template=INTERNLM2_META,
+            tp=1,
+            top_k=1,
+            temperature=1.0,
+            stop_words=['\n```\n', '<|im_end|>'],
+            max_new_tokens=1024,
+        )
+        self.agent = Agent(
+            llm,
+            system_prompt,
+            output_format=ToolParser(
+                tool_type='code interpreter', begin='```python\n', end='\n```\n'
+            ),
+            # `InternLMToolAggregator` is adapted to `ToolParser` for aggregating
+            # messages with tool invocations and execution results
+            aggregator=InternLMToolAggregator(),
+        )
+        self.executor = ActionExecutor([IPythonInteractive()], hooks=[CodeProcessor()])
+        self.max_turn = max_turn
+
+    def forward(self, message: AgentMessage, session_id=0) -> AgentMessage:
+        for _ in range(self.max_turn):
+            message = self.agent(message, session_id=session_id)
+            if message.formatted['tool_type'] is None:
+                return message
+            message = self.executor(message, session_id=session_id)
+        return message
+
+coder = Coder('Qwen/Qwen2-7B-Instruct', 'Solve the problem step by step with assistance of Python code')
+query = AgentMessage(
+    sender='user',
+    content='Find the projection of $\\mathbf{a}$ onto $\\mathbf{b} = '
+    '\\begin{pmatrix} 1 \\\\ -3 \\end{pmatrix}$ if $\\mathbf{a} \\cdot \\mathbf{b} = 2.$'
+)
+answer = coder(query)
+print(answer.content)
+print('-' * 120)
+for msg in coder.state_dict()['agent.memory']:
+    print('*' * 80)
+    print(f'{msg["sender"]}:\n\n{msg["content"]}')
+````
+
+### Multiple Agents
+
+Asynchronous blogging agents that improve writing quality by self-refinement ([original AutoGen example](https://microsoft.github.io/autogen/0.2/docs/topics/prompting-and-reasoning/reflection/))
+
+```python
+import asyncio
+import os
+from lagent.llms import AsyncGPTAPI
+from lagent.agents import AsyncAgent
+os.environ['OPENAI_API_KEY'] = 'YOUR_API_KEY'
+
+class PrefixedMessageHook(Hook):
+    def __init__(self, prefix: str, senders: list = None):
+        self.prefix = prefix
+        self.senders = senders or []
+
+    def before_agent(self, agent, messages, session_id):
+        for message in messages:
+            if message.sender in self.senders:
+                message.content = self.prefix + message.content
+
+class AsyncBlogger(AsyncAgent):
+    def __init__(self, model_path, writer_prompt, critic_prompt, critic_prefix='', max_turn=3):
+        super().__init__()
+        llm = AsyncGPTAPI(model_type=model_path, retry=5, max_new_tokens=2048)
+        self.writer = AsyncAgent(llm, writer_prompt, name='writer')
+        self.critic = AsyncAgent(
+            llm, critic_prompt, name='critic', hooks=[PrefixedMessageHook(critic_prefix, ['writer'])]
+        )
+        self.max_turn = max_turn
+
+    async def forward(self, message: AgentMessage, session_id=0) -> AgentMessage:
+        for _ in range(self.max_turn):
+            message = await self.writer(message, session_id=session_id)
+            message = await self.critic(message, session_id=session_id)
+        return await self.writer(message, session_id=session_id)
+
+blogger = AsyncBlogger(
+    'gpt-4o-2024-05-13',
+    writer_prompt="You are an writing assistant tasked to write engaging blogpost. You try to generate the best blogpost possible for the user's request. "
+    "If the user provides critique, then respond with a revised version of your previous attempts",
+    critic_prompt="Generate critique and recommendations on the writing. Provide detailed recommendations, including requests for length, depth, style, etc..",
+    critic_prefix='Reflect and provide critique on the following writing. \n\n',
+)
+user_prompt = (
+    "Write an engaging blogpost on the recent updates in {topic}. "
+    "The blogpost should be engaging and understandable for general audience. "
+    "Should have more than 3 paragraphes but no longer than 1000 words.")
+bot_msgs = asyncio.get_event_loop().run_until_complete(
+    asyncio.gather(
+        *[
+            blogger(AgentMessage(sender='user', content=user_prompt.format(topic=topic)), session_id=i)
+            for i, topic in enumerate(['AI', 'Biotechnology', 'New Energy', 'Video Games', 'Pop Music'])
+        ]
+    )
+)
+print(bot_msgs[0].content)
+print('-' * 120)
+for msg in blogger.state_dict(session_id=0)['writer.memory']:
+    print('*' * 80)
+    print(f'{msg["sender"]}:\n\n{msg["content"]}')
+print('-' * 120)
+for msg in blogger.state_dict(session_id=0)['critic.memory']:
+    print('*' * 80)
+    print(f'{msg["sender"]}:\n\n{msg["content"]}')
+```
+
+A multi-agent workflow that performs information retrieval, data collection and chart plotting ([original LangGraph example](https://vijaykumarkartha.medium.com/multiple-ai-agents-creating-multi-agent-workflows-using-langgraph-and-langchain-0587406ec4e6))
+
+<div align="center">
+    <img src="https://miro.medium.com/v2/resize:fit:1400/format:webp/1*ffzadZCKXJT7n4JaRVFvcQ.jpeg" width="850" />
+</div>
+
+````python
+import json
+from lagent.actions import IPythonInterpreter, WebBrowser, ActionExecutor
+from lagent.agents.stream import get_plugin_prompt
+from lagent.llms import GPTAPI
+from lagent.hooks import InternLMActionProcessor
+
+TOOL_TEMPLATE = (
+    "You are a helpful AI assistant, collaborating with other assistants. Use the provided tools to progress"
+    " towards answering the question. If you are unable to fully answer, that's OK, another assistant with"
+    " different tools will help where you left off. Execute what you can to make progress. If you or any of"
+    " the other assistants have the final answer or deliverable, prefix your response with {finish_pattern}"
+    " so the team knows to stop. You have access to the following tools:\n{tool_description}\nPlease provide"
+    " your thought process when you need to use a tool, followed by the call statement in this format:"
+    "\n{invocation_format}\\\\n**{system_prompt}**"
+)
+
+class DataVisualizer(Agent):
+    def __init__(self, model_path, research_prompt, chart_prompt, finish_pattern="Final Answer", max_turn=10):
+        super().__init__()
+        llm = GPTAPI(model_path, key='YOUR_OPENAI_API_KEY', retry=5, max_new_tokens=1024, stop_words=["```\n"])
+        interpreter, browser = IPythonInterpreter(), WebBrowser("BingSearch", api_key="YOUR_BING_API_KEY")
+        self.researcher = Agent(
+            llm,
+            TOOL_TEMPLATE.format(
+                finish_pattern=finish_pattern,
+                tool_description=get_plugin_prompt(browser),
+                invocation_format='```json\n{"name": {{tool name}}, "parameters": {{keyword arguments}}}\n```\n',
+                system_prompt=research_prompt,
+            ),
+            output_format=ToolParser(
+                "browser",
+                begin="```json\n",
+                end="\n```\n",
+                validate=lambda x: json.loads(x.rstrip('`')),
+            ),
+            aggregator=InternLMToolAggregator(),
+            name="researcher",
+        )
+        self.charter = Agent(
+            llm,
+            TOOL_TEMPLATE.format(
+                finish_pattern=finish_pattern,
+                tool_description=interpreter.name,
+                invocation_format='```python\n{{code}}\n```\n',
+                system_prompt=chart_prompt,
+            ),
+            output_format=ToolParser(
+                "interpreter",
+                begin="```python\n",
+                end="\n```\n",
+                validate=lambda x: x.rstrip('`'),
+            ),
+            aggregator=InternLMToolAggregator(),
+            name="charter",
+        )
+        self.executor = ActionExecutor([interpreter, browser], hooks=[InternLMActionProcessor()])
+        self.finish_pattern = finish_pattern
+        self.max_turn = max_turn
+
+    def forward(self, message, session_id=0):
+        for _ in range(self.max_turn):
+            message = self.researcher(message, session_id=session_id, stop_words=["```\n", "```python"]) # override llm stop words
+            while message.formatted["tool_type"]:
+                message = self.executor(message, session_id=session_id)
+                message = self.researcher(message, session_id=session_id, stop_words=["```\n", "```python"])
+            if self.finish_pattern in message.content:
+                return message
+            message = self.charter(message)
+            while message.formatted["tool_type"]:
+                message = self.executor(message, session_id=session_id)
+                message = self.charter(message, session_id=session_id)
+            if self.finish_pattern in message.content:
+                return message
+        return message
+
+visualizer = DataVisualizer(
+    "gpt-4o-2024-05-13",
+    research_prompt="You should provide accurate data for the chart generator to use.",
+    chart_prompt="Any charts you display will be visible by the user.",
+)
+user_msg = AgentMessage(
+    sender='user',
+    content="Fetch the China's GDP over the past 5 years, then draw a line graph of it. Once you code it up, finish.")
+bot_msg = visualizer(user_msg)
+print(bot_msg.content)
+json.dump(visualizer.state_dict(), open('visualizer.json', 'w'), ensure_ascii=False, indent=4)
+````

docs/en/index.rst

@@ -0,0 +1,40 @@
+Welcome to Lagent's documentation!
+=======================================
+
+You can switch between English and Chinese in the lower-left corner of the layout.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Get Started
+
+   get_started/install.md
+   get_started/quickstart.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials
+
+   tutorials/action.md
+
+.. toctree::
+   :caption: Switch Language
+
+   switch_language.md
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Reference
+
+   autoapi/lagent/actions/index
+   autoapi/lagent/agents/index
+   autoapi/lagent/llms/index
+   autoapi/lagent/utils/index
+   autoapi/lagent/schema/index
+   autoapi/lagent/version/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

docs/en/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/en/requirements.txt

@@ -0,0 +1,4 @@
+recommonmark
+sphinx
+sphinx_markdown_tables
+sphinx_rtd_theme

docs/en/switch_language.md

@@ -0,0 +1,3 @@
+## <a href='https://lagent.readthedocs.io/en/latest/'>English</a>
+
+## <a href='https://lagent.readthedocs.io/zh-cn/latest/'>简体中文</a>

docs/en/tutorials/action.md

@@ -0,0 +1,400 @@
+# Action
+
+Actions, also called **tools**, provide a suite of functions LLM-driven agents can use to interact with the real world and perform complex tasks.
+
+## Basic Concepts
+
+### Tool & Toolkit
+
+There are two categories of tools:
+
+- tool: provide only one API to call.
+- toolkit: implement multiple APIs that undertake different sub-tasks.
+
+### Tool Description
+
+In Lagent, the tool description is a dictionary containing the action's core information of usage, observed by LLMs for decision-making.
+
+For simple tools, the description can be created as follows
+
+```python
+TOOL_DESCRIPTION = {
+    'name': 'bold',  # name of the tool
+    'description': 'a function used to make text bold',  # introduce the tool's function
+    'parameters': [  # a list of parameters the tool take.
+        {
+            'name': 'text', 'type': 'STRING', 'description': 'input content'
+        }
+    ],
+    'required': ['text'],  # specify names of parameters required
+}
+```
+
+In some situations there may be optional `return_data`, `parameter_description` keys describing the returns and argument passing format respectively.
+
+```{attention}
+`parameter_description` is usually inserted into the tool description automatically by the action's parser. It will be introduced in [Interface Design](#interface-design) .
+```
+
+For toolkits, the description is very similar but nest submethods
+
+```python
+TOOL_DESCRIPTION = {
+    'name': 'PhraseEmphasis',  # name of the toolkit
+    'description': 'a toolkit which provides different styles of text emphasis',  # introduce the tool's function
+    'api_list': [
+        {
+            'name': 'bold',
+            'description': 'make text bold',
+            'parameters': [
+                {
+                    'name': 'text', 'type': 'STRING', 'description': 'input content'
+                }
+            ],
+            'required': ['text']
+        },
+        {
+            'name': 'italic',
+            'description': 'make text italic',
+            'parameters': [
+                {
+                    'name': 'text', 'type': 'STRING', 'description': 'input content'
+                }
+            ],
+            'required': ['text']
+        }
+    ]
+}
+```
+
+## Make Functions Tools
+
+It's not necessary to prepare an extra description for a defined function. In Lagent we provide a decorator `tool_api` which can conveniently turn a function into a tool by automatically parsing the function's typehints and dosctrings to generate the description dictionary and binding it to an attribute `api_description`.
+
+```python
+from lagent import tool_api
+
+@tool_api
+def bold(text: str) -> str:
+    """make text bold
+
+    Args:
+        text (str): input text
+
+    Returns:
+        str: bold text
+    """
+    return '**' + text + '**'
+
+
+bold.api_description
+```
+
+```python
+{'name': 'bold',
+ 'description': 'make text bold',
+ 'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input text'}],
+ 'required': ['text']}
+```
+
+Once `returns_named_value` is enabled you should declare the name of the return data, which will be processed to form a new field `return_data`:
+
+```python
+@tool_api(returns_named_value=True)
+def bold(text: str) -> str:
+    """make text bold
+
+    Args:
+        text (str): input text
+
+    Returns:
+        bold_text (str): bold text
+    """
+    return '**' + text + '**'
+
+bold.api_description
+```
+
+```python
+{'name': 'bold',
+ 'description': 'make text bold',
+ 'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input text'}],
+ 'required': ['text'],
+ 'return_data': [{'name': 'bold_text',
+   'description': 'bold text',
+   'type': 'STRING'}]}
+```
+
+Sometimes the tool may return a `dict` or `tuple`, and you want to elaborate each member in `return_data` rather than take them as a whole. Set `explode_return=True` and list them in the return part of docstrings.
+
+```python
+@tool_api(explode_return=True)
+def list_args(a: str, b: int, c: float = 0.0) -> dict:
+    """Return arguments in dict format
+
+    Args:
+        a (str): a
+        b (int): b
+        c (float): c
+
+    Returns:
+        dict: input arguments
+            - a (str): a
+            - b (int): b
+            - c: c
+    """
+    return {'a': a, 'b': b, 'c': c}
+```
+
+```python
+{'name': 'list_args',
+ 'description': 'Return arguments in dict format',
+ 'parameters': [{'name': 'a', 'type': 'STRING', 'description': 'a'},
+  {'name': 'b', 'type': 'NUMBER', 'description': 'b'},
+  {'name': 'c', 'type': 'FLOAT', 'description': 'c'}],
+ 'required': ['a', 'b'],
+ 'return_data': [{'name': 'a', 'description': 'a', 'type': 'STRING'},
+  {'name': 'b', 'description': 'b', 'type': 'NUMBER'},
+  {'name': 'c', 'description': 'c'}]}
+```
+
+```{warning}
+Only Google style Python docstrings is currently supported.
+```
+
+## Interface Design
+
+`BaseAction(description=None, parser=JsonParser, enable=True)` is the base class all actions should inherit from. It takes three initialization arguments
+
+- **description**: a tool description dictionary, used set instance attribute `description`. Mostly you don't need explicitly pass this argument since the meta class of `BaseAction` will search methods decorated by `tool_api` and assemble their `api_description` as a class attribute `__tool_description__`, and if the initial `description` is left null, then `__tool_description__` will be copied as `description`.
+
+- **parser**: `BaseParser` class. It will instantialize a parser used to validate the arguments of APIs in `description`.
+
+  For example, `JsonParser` requires arguments passed in the format of JSON or `dict`. To make LLMs aware of this, It inserts a field `parameter_description` into the `description`.
+
+  ```python
+  from lagent import BaseAction
+
+  action = BaseAction(
+      {
+          'name': 'bold',
+          'description': 'a function used to make text bold',
+          'parameters': [
+              {
+                  'name': 'text', 'type': 'STRING', 'description': 'input content'
+              }
+          ],
+          'required': ['text']
+      }
+  )
+  action.description
+  ```
+
+  ```python
+  {'name': 'bold',
+   'description': 'a function used to make text bold',
+   'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input content'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}
+  ```
+
+- **enable**: specify whether the tool is available.
+
+### Custom Action
+
+A simple tool must have its `run` method implemented, while APIs of toolkits should avoid naming conflicts with this reserved word.
+
+```{tip}
+`run` is allowed not to be decorated by `tool_api` for simple tools unless you want to hint the return data.
+```
+
+```python
+class Bold(BaseAction):
+
+    def run(self, text: str):
+        """make text bold
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: bold text
+        """
+        return '**' + text + '**'
+
+class PhraseEmphasis(BaseAction):
+    """a toolkit which provides different styles of text emphasis"""
+
+    @tool_api
+    def bold(self, text):
+        """make text bold
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: bold text
+        """
+        return '**' + text + '**'
+
+    @tool_api
+    def italic(self, text):
+        """make text italic
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: italic text
+        """
+        return '*' + text + '*'
+
+# Inspect the default description
+# Bold.__tool_description__, PhraseEmphasis.__tool_description__
+```
+
+### Auto-registration
+
+Any subclass of `BaseAction` will be registered automatically. You can use `list_tools()` and `get_tool()` to view all tools and initialize by name.
+
+```python
+from lagent import list_tools, get_tool
+
+list_tools()
+```
+
+```python
+['BaseAction',
+ 'InvalidAction',
+ 'NoAction',
+ 'FinishAction',
+ 'ArxivSearch',
+ 'BINGMap',
+ 'GoogleScholar',
+ 'GoogleSearch',
+ 'IPythonInterpreter',
+ 'PPT',
+ 'PythonInterpreter',
+ 'Bold',
+ 'PhraseEmphasis']
+```
+
+Create a `PhraseEmphasis` object
+
+```python
+action = get_tool('PhraseEmphasis')
+action.description
+```
+
+```python
+{'name': 'PhraseEmphasis',
+ 'description': 'a toolkit which provides different styles of text emphasis',
+ 'api_list': [{'name': 'bold',
+   'description': 'make text bold',
+   'parameters': [{'name': 'text',
+     'type': 'STRING',
+     'description': 'input text'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'},
+  {'name': 'italic',
+   'description': 'make text italic',
+   'parameters': [{'name': 'text',
+     'type': 'STRING',
+     'description': 'input text'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}]}
+```
+
+## Tool Calling
+
+### Run a Tool
+
+`__call__` method of `Action` takes two arguments
+
+- `inputs`: It depends on the action's parser. Often a string in specific formats generated by LLMs.
+  - `JsonParser`: Allow passing arguments in the format of JSON string or Python `dict`.
+  - `TupleParser`: Allow passing arguments in the format of tuple string format or Python `tuple`.
+- `name`: Which API to call. Default is `run`.
+
+It returns an `ActionReturn` object which encapsulates calling details
+
+- `args`: Dictionary of action inputs.
+- `type`: Action name.
+- `result`: List of dicts. Each contains two keys: 'type' and 'content'. when errors occur, it is `None`.
+- `errmsg`: Error message. Default is `None`.
+
+Below is an example
+
+```python
+from lagent import IPythonInterpreter, TupleParser
+
+action1 = IPythonInterpreter()
+ret = action1('{"command": "import math;math.sqrt(100)"}')
+print(ret.result)
+ret = action1({'command': 'import math;math.sqrt(100)'})
+print(ret.result)
+
+action2 = IPythonInterpreter(parser=TupleParser)
+ret = action2('("import math;math.sqrt(100)", )')
+print(ret.result)
+ret = action2(('import math;math.sqrt(100)',))
+print(ret.result)
+```
+
+```python
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+```
+
+### Dynamic Invocation
+
+Lagent provides an `ActionExecutor` to manage multiple tools. It will flatten `api_list` of toolkits and rename each `{tool_name}.{api_name}`.
+
+```python
+from lagent import ActionExecutor, ArxivSearch, IPythonInterpreter
+
+executor = ActionExecutor(actions=[ArxivSearch(), IPythonInterpreter()])
+executor.get_actions_info()  # This information is fed to LLMs as the tool meta prompt
+```
+
+```python
+[{'name': 'ArxivSearch.get_arxiv_article_information',
+  'description': 'Run Arxiv search and get the article meta information.',
+  'parameters': [{'name': 'query',
+    'type': 'STRING',
+    'description': 'the content of search query'}],
+  'required': ['query'],
+  'return_data': [{'name': 'content',
+    'description': 'a list of 3 arxiv search papers',
+    'type': 'STRING'}],
+  'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'},
+ {'name': 'IPythonInterpreter',
+  'description': "When you send a message containing Python code to python, it will be executed in a stateful Jupyter notebook environment. python will respond with the output of the execution or time out after 60.0 seconds. The drive at '/mnt/data' can be used to save and persist user files. Internet access for this session is disabled. Do not make external web requests or API calls as they will fail.",
+  'parameters': [{'name': 'command',
+    'type': 'STRING',
+    'description': 'Python code'},
+   {'name': 'timeout',
+    'type': 'NUMBER',
+    'description': 'Upper bound of waiting time for Python script execution.'}],
+  'required': ['command'],
+  'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}]
+```
+
+Trigger an action through the executor
+
+```python
+ret = executor('IPythonInterpreter', '{"command": "import math;math.sqrt(100)"}')
+ret.result
+```
+
+```python
+[{'type': 'text', 'content': '10.0'}]
+```

docs/zh_cn/.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+formats: all
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: requirements/docs.txt
+
+sphinx:
+  configuration: docs/zh_cn/conf.py

docs/zh_cn/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/zh_cn/_static/css/readthedocs.css

@@ -0,0 +1,6 @@
+.header-logo {
+    background-image: url("../images/lagent_icon.png");
+    background-size: 40px 40px;
+    height: 40px;
+    width: 40px;
+}

docs/zh_cn/_static/js/collapsed.js

@@ -0,0 +1 @@
+var collapsedSections = ['API 文档']

docs/zh_cn/_static/js/table.js

@@ -0,0 +1,31 @@
+$(document).ready(function () {
+    table = $('.model-summary').DataTable({
+        "stateSave": false,
+        "lengthChange": false,
+        "pageLength": 10,
+        "order": [],
+        "scrollX": true,
+        "columnDefs": [
+            { "type": "summary", targets: '_all' },
+        ]
+    });
+    // Override the default sorting for the summary columns, which
+    // never takes the "-" character into account.
+    jQuery.extend(jQuery.fn.dataTableExt.oSort, {
+        "summary-asc": function (str1, str2) {
+            if (str1 == "<p>-</p>")
+                return 1;
+            if (str2 == "<p>-</p>")
+                return -1;
+            return ((str1 < str2) ? -1 : ((str1 > str2) ? 1 : 0));
+        },
+
+        "summary-desc": function (str1, str2) {
+            if (str1 == "<p>-</p>")
+                return 1;
+            if (str2 == "<p>-</p>")
+                return -1;
+            return ((str1 < str2) ? 1 : ((str1 > str2) ? -1 : 0));
+        }
+    });
+})

docs/zh_cn/_templates/autoapi/index.rst

@@ -0,0 +1,14 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation.
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   {% for page in pages %}
+   {% if page.top_level_object and page.display %}
+   {{ page.include_path }}
+   {% endif %}
+   {% endfor %}

docs/zh_cn/_templates/autoapi/python/module.rst

@@ -0,0 +1,112 @@
+{% if not obj.display %}
+:orphan:
+
+{% endif %}
+:py:mod:`{{ obj.name if obj.name.count(".") <= 1 else obj.short_name }}`
+=========={{ "=" * (obj.name|length if obj.name.count(".") <= 1 else obj.short_name|length) }}
+
+.. py:module:: {{ obj.name }}
+
+{% if obj.docstring %}
+.. autoapi-nested-parse::
+
+   {{ obj.docstring|indent(3) }}
+
+{% endif %}
+
+{% block subpackages %}
+{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
+{% if visible_subpackages %}
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+{% for subpackage in visible_subpackages %}
+   {{ subpackage.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block submodules %}
+{% set visible_submodules = obj.submodules|selectattr("display")|list %}
+{% if visible_submodules %}
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+{% for submodule in visible_submodules %}
+   {{ submodule.short_name }}/index.rst
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% block content %}
+{% if obj.type is equalto("package") %}
+{% set visible_children = obj.children|selectattr("display")|list %}
+{% else %}
+{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
+{% endif %}
+{% if visible_children %}
+{{ obj.type|title }} Contents
+{{ "-" * obj.type|length }}---------
+
+{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
+{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
+{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}
+{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
+{% block classes scoped %}
+{% if visible_classes %}
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+{% for klass in visible_classes %}
+   {{ klass.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block functions scoped %}
+{% if visible_functions %}
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+{% for function in visible_functions %}
+   {{ function.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+
+{% block attributes scoped %}
+{% if visible_attributes %}
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+{% for attribute in visible_attributes %}
+   {{ attribute.id }}
+{% endfor %}
+
+
+{% endif %}
+{% endblock %}
+{% endif %}
+{% for obj_item in visible_children %}
+{{ obj_item.render()|indent(0) }}
+{% endfor %}
+{% endif %}
+{% endblock %}

docs/zh_cn/_templates/classtemplate.rst

@@ -0,0 +1,14 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:
+
+
+..
+  autogenerated from source/_templates/classtemplate.rst
+  note it does not have :inherited-members:

docs/zh_cn/conf.py

@@ -0,0 +1,108 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import re
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information -----------------------------------------------------
+project = 'Lagent'
+copyright = '2020-2030, InternLM'
+author = 'InternLM'
+language = 'zh_CN'
+
+# The full version, including alpha/beta/rc tags
+version_file = '../../lagent/version.py'
+with open(version_file) as f:
+    exec(compile(f.read(), version_file, 'exec'))
+__version__ = locals()['__version__']
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx_rtd_theme',
+    'myst_nb',
+    'autoapi.extension',
+    'sphinx_markdown_tables',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+]
+
+nb_output_stderr = 'remove-warn'
+autodoc_typehints = 'description'
+
+# sphinx-autoapi configuration
+autoapi_dirs = ['../../lagent']
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+    'show-module-summary',
+]
+autoapi_ignore = ['*migrations*', '*command.py', '*cli.py']
+autoapi_template_dir = '_templates/autoapi'
+autoapi_add_toctree_entry = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    'navigation_depth': 3,
+    'titles_only': False,
+    'style_nav_header_background': '#4fabab',
+}
+html_context = {
+    'display_github': True,
+    'github_host': 'github.com',
+    'github_user': 'InternLM',
+    'github_repo': 'lagent',
+    'github_version': 'main',
+    'conf_py_path': '/docs/zh_cn/',
+}
+html_title = 'Lagent'
+html_logo = '../imgs/lagent_logo.png'
+html_favicon = '../imgs/lagent_icon.png'
+
+master_doc = 'index'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named 'default.css' will overwrite the builtin 'default.css'.
+html_static_path = ['_static']
+
+
+def custom_skip(app, what, name, obj, skip, options):
+    if what in ['data', 'function', 'class'] and re.search('logger', name):
+        skip = True
+    return skip
+
+
+def setup(sphinx):
+    sphinx.connect('autoapi-skip-member', custom_skip)

docs/zh_cn/cp_origin_docs.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# Copy *.md files from docs/ if it doesn't have a Chinese translation
+
+for filename in $(find ../en/ -name '*.md' -printf "%P\n");
+do
+    mkdir -p $(dirname $filename)
+    cp -n ../en/$filename ./$filename
+done

docs/zh_cn/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table_style: colwidths-auto

docs/zh_cn/get_started/install.md

@@ -0,0 +1,19 @@
+# 安装方式
+
+## pip安装
+
+推荐使用 pip 安装
+
+```bash
+pip install lagent
+```
+
+## 源码安装
+
+如需修改部分功能，可以从源码构建 Lagent
+
+```bash
+git clone https://github.com/InternLM/lagent.git
+cd lagent
+pip install -e .
+```

docs/zh_cn/index.rst

@@ -0,0 +1,39 @@
+欢迎来到 Lagent 的中文文档!
+=======================================
+
+您可以在页面左下角切换中英文文档。
+
+.. toctree::
+   :maxdepth: 2
+   :caption: 新手入门
+
+   get_started/install.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: 教程
+
+   tutorials/action.md
+
+.. toctree::
+   :caption: 切换语言
+
+   switch_language.md
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API 参考
+
+   autoapi/lagent/actions/index
+   autoapi/lagent/agents/index
+   autoapi/lagent/llms/index
+   autoapi/lagent/utils/index
+   autoapi/lagent/schema/index
+   autoapi/lagent/version/index
+
+
+导引
+==================
+
+* :ref:`genindex`
+* :ref:`search`

docs/zh_cn/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/zh_cn/switch_language.md

@@ -0,0 +1,3 @@
+## <a href='https://lagent.readthedocs.io/en/latest/'>English</a>
+
+## <a href='https://lagent.readthedocs.io/zh-cn/latest/'>简体中文</a>

docs/zh_cn/tutorials/action.md

@@ -0,0 +1,398 @@
+# 动作
+
+动作，也被称为工具，提供了一套LLM驱动的智能体用来与真实世界交互并执行复杂任务的函数。
+
+## 基本概念
+
+### 工具 & 工具包
+
+有两种类型的工具：
+
+- 简单工具: 只提供一个API接口供调用。
+- 工具包: 实现多个API接口，承担不同的子任务。
+
+### 工具描述
+
+在Lagent中，工具描述是一个刻画工具调用方式的字典，能够被LLM观察并用于决策。
+
+对于简单工具，描述可按如下格式声明:
+
+```python
+TOOL_DESCRIPTION = {
+    'name': 'bold',  # 工具名称
+    'description': 'a function used to make text bold',  # 介绍工具的功能
+    'parameters': [  # 这个工具所需要的参数列表
+        {
+            'name': 'text', 'type': 'STRING', 'description': 'input content'
+        }
+    ],
+    'required': ['text'],  # 指定必需的参数名
+}
+```
+
+在某些情况下，可能还包含 `return_data`，`parameter_description` 字段，分别描述返回内容及参数传递格式。
+
+```{attention}
+`parameter_description` 通常被动作的解析器自动插入到工具描述中，这部分将在[接口设计](#id6)中进行介绍。
+```
+
+对于工具包，描述非常相似，但嵌套了子方法
+
+```python
+TOOL_DESCRIPTION = {
+    'name': 'PhraseEmphasis',  # 工具包的名字
+    'description': 'a toolkit which provides different styles of text emphasis',  # 介绍工具包的功能
+    'api_list': [
+        {
+            'name': 'bold',
+            'description': 'make text bold',
+            'parameters': [
+                {
+                    'name': 'text', 'type': 'STRING', 'description': 'input content'
+                }
+            ],
+            'required': ['text']
+        },
+        {
+            'name': 'italic',
+            'description': 'make text italic',
+            'parameters': [
+                {
+                    'name': 'text', 'type': 'STRING', 'description': 'input content'
+                }
+            ],
+            'required': ['text']
+        }
+    ]
+}
+```
+
+## 将函数转换为工具
+
+对于已定义好的函数，无需人工添加额外的描述。在 Lagent 中，我们提供了一个修饰器 `tool_api`，它可以通过自动解析函数的类型提示和文档字符串来生成描述字典，并将其绑定到属性 `api_description`。
+
+```python
+from lagent import tool_api
+
+@tool_api
+def bold(text: str) -> str:
+    """make text bold
+
+    Args:
+        text (str): input text
+
+    Returns:
+        str: bold text
+    """
+    return '**' + text + '**'
+
+
+bold.api_description
+```
+
+```python
+{'name': 'bold',
+ 'description': 'make text bold',
+ 'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input text'}],
+ 'required': ['text']}
+```
+
+一旦启用 `returns_named_value`，您应当声明返回值的名称，这将被处理成一个新的字段 `return_data`：
+
+```python
+@tool_api(returns_named_value=True)
+def bold(text: str) -> str:
+    """make text bold
+
+    Args:
+        text (str): input text
+
+    Returns:
+        bold_text (str): bold text
+    """
+    return '**' + text + '**'
+
+bold.api_description
+```
+
+```python
+{'name': 'bold',
+ 'description': 'make text bold',
+ 'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input text'}],
+ 'required': ['text'],
+ 'return_data': [{'name': 'bold_text',
+   'description': 'bold text',
+   'type': 'STRING'}]}
+```
+
+有时工具可能返回一个 `dict` 或 `tuple`，如果你想在 `return_data` 中详细说明每个成员的含义而不是把它们当作一个整体，设置 `explode_return=True` 并在文档字符串的 Returns 部分中罗列它们。
+
+```python
+@tool_api(explode_return=True)
+def list_args(a: str, b: int, c: float = 0.0) -> dict:
+    """Return arguments in dict format
+
+    Args:
+        a (str): a
+        b (int): b
+        c (float): c
+
+    Returns:
+        dict: input arguments
+            - a (str): a
+            - b (int): b
+            - c: c
+    """
+    return {'a': a, 'b': b, 'c': c}
+```
+
+```python
+{'name': 'list_args',
+ 'description': 'Return arguments in dict format',
+ 'parameters': [{'name': 'a', 'type': 'STRING', 'description': 'a'},
+  {'name': 'b', 'type': 'NUMBER', 'description': 'b'},
+  {'name': 'c', 'type': 'FLOAT', 'description': 'c'}],
+ 'required': ['a', 'b'],
+ 'return_data': [{'name': 'a', 'description': 'a', 'type': 'STRING'},
+  {'name': 'b', 'description': 'b', 'type': 'NUMBER'},
+  {'name': 'c', 'description': 'c'}]}
+```
+
+```{warning}
+目前仅支持 Google 格式的 Python 文档字符串。
+```
+
+## 接口设计
+
+`BaseAction(description=None, parser=JsonParser, enable=True)` 是所有动作应该继承的基类，它接收三个初始化参数：
+
+- **description**：一个工具描述的字典��用于设置实例属性 `description`。通常不需要显式地传递这个参数，因为 `BaseAction` 的元类将查找被 `tool_api` 装饰的方法，并组装它们的 `api_description` 构造一个类属性 `__tool_description__`，如果实例化时 `description` 为空，那么该实例属性将置为 `__tool_description__`。
+
+- **parser**：`BaseParser` 类，用于实例化一个动作解析器校验 `description` 所描述的工具的参数。例如，`JsonParser` 会要求模型在调用工具时传入一个 JSON 格式字符串或者 Python 字典，为了让 LLM 感知到该指令，它会在 `description` 中插入一个 `parameter_description` 字段。
+
+  ```python
+  from lagent import BaseAction
+
+  action = BaseAction(
+      {
+          'name': 'bold',
+          'description': 'a function used to make text bold',
+          'parameters': [
+              {
+                  'name': 'text', 'type': 'STRING', 'description': 'input content'
+              }
+          ],
+          'required': ['text']
+      }
+  )
+  action.description
+  ```
+
+  ```python
+  {'name': 'bold',
+   'description': 'a function used to make text bold',
+   'parameters': [{'name': 'text',
+   'type': 'STRING',
+   'description': 'input content'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}
+  ```
+
+- **enable**: 指明该动作是否生效。
+
+### 自定义动作
+
+一个简单工具必须实现 `run` 方法，而工具包则应当避免将各子API名称定义为该保留字段。
+
+```{tip}
+对于非工具包的 Action，`run` 允许不被 `tool_api` 装饰，除非你想提示返回信息。
+```
+
+```python
+class Bold(BaseAction):
+
+    def run(self, text: str):
+        """make text bold
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: bold text
+        """
+        return '**' + text + '**'
+
+class PhraseEmphasis(BaseAction):
+    """a toolkit which provides different styles of text emphasis"""
+
+    @tool_api
+    def bold(self, text):
+        """make text bold
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: bold text
+        """
+        return '**' + text + '**'
+
+    @tool_api
+    def italic(self, text):
+        """make text italic
+
+        Args:
+            text (str): input text
+
+        Returns:
+            str: italic text
+        """
+        return '*' + text + '*'
+
+# 查看默认工具描述
+# Bold.__tool_description__, PhraseEmphasis.__tool_description__
+```
+
+### 自动注册
+
+任何 `BaseAction` 的子类都会自动被注册。你可以使用 `list_tools()` 和 `get_tool()` 来查看所有工具类并通过工具名进行初始化。
+
+```python
+from lagent import list_tools, get_tool
+
+list_tools()
+```
+
+```python
+['BaseAction',
+ 'InvalidAction',
+ 'NoAction',
+ 'FinishAction',
+ 'ArxivSearch',
+ 'BINGMap',
+ 'GoogleScholar',
+ 'GoogleSearch',
+ 'IPythonInterpreter',
+ 'PPT',
+ 'PythonInterpreter',
+ 'Bold',
+ 'PhraseEmphasis']
+```
+
+创建一个 `PhraseEmphasis` 对象。
+
+```python
+action = get_tool('PhraseEmphasis')
+action.description
+```
+
+```python
+{'name': 'PhraseEmphasis',
+ 'description': 'a toolkit which provides different styles of text emphasis',
+ 'api_list': [{'name': 'bold',
+   'description': 'make text bold',
+   'parameters': [{'name': 'text',
+     'type': 'STRING',
+     'description': 'input text'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'},
+  {'name': 'italic',
+   'description': 'make text italic',
+   'parameters': [{'name': 'text',
+     'type': 'STRING',
+     'description': 'input text'}],
+   'required': ['text'],
+   'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}]}
+```
+
+## 工具调用
+
+### 执行工具
+
+`Action` 的 `__call__` 方法需要传入两个参数
+
+- `inputs`: 其类型与动作绑定的 `BaseParser` 相关，通常是由大语言模型生成的字符串。
+  - `JsonParser`: 允许传入 JSON 格式字符串或 Python 字典。
+  - `TupleParser`: 允许传入字面量为元组的字符串或 Python 元组。
+- `name`: 调用哪个 API，默认为 `run`。
+
+工具会返回一个封装了调用细节的 `ActionReturn` 对象。
+
+- `args`: 一个字典，表示该动作的入参。
+- `type`: 动作名称。
+- `result`: 以字典为成员的列表，每个字典包含两个键——'type' 和 'content'，发生异常时该字段为 `None`。
+- `errmsg`: 错误信息，默认为 `None`。
+
+以下是一个例子：
+
+```python
+from lagent import IPythonInterpreter, TupleParser
+
+action1 = IPythonInterpreter()
+ret = action1('{"command": "import math;math.sqrt(100)"}')
+print(ret.result)
+ret = action1({'command': 'import math;math.sqrt(100)'})
+print(ret.result)
+
+action2 = IPythonInterpreter(parser=TupleParser)
+ret = action2('("import math;math.sqrt(100)", )')
+print(ret.result)
+ret = action2(('import math;math.sqrt(100)',))
+print(ret.result)
+```
+
+```python
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+[{'type': 'text', 'content': '10.0'}]
+```
+
+### 动态触发
+
+Lagent 提供 `ActionExecutor` 接口管理多个工具，它会将工具包的 `api_list` 平展并将各 API 更名为 `{tool_name}.{api_name}`。
+
+```python
+from lagent import ActionExecutor, ArxivSearch, IPythonInterpreter
+
+executor = ActionExecutor(actions=[ArxivSearch(), IPythonInterpreter()])
+executor.get_actions_info()  # 该结果会作为LLM系统提示词的一部分
+```
+
+```python
+[{'name': 'ArxivSearch.get_arxiv_article_information',
+  'description': 'Run Arxiv search and get the article meta information.',
+  'parameters': [{'name': 'query',
+    'type': 'STRING',
+    'description': 'the content of search query'}],
+  'required': ['query'],
+  'return_data': [{'name': 'content',
+    'description': 'a list of 3 arxiv search papers',
+    'type': 'STRING'}],
+  'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'},
+ {'name': 'IPythonInterpreter',
+  'description': "When you send a message containing Python code to python, it will be executed in a stateful Jupyter notebook environment. python will respond with the output of the execution or time out after 60.0 seconds. The drive at '/mnt/data' can be used to save and persist user files. Internet access for this session is disabled. Do not make external web requests or API calls as they will fail.",
+  'parameters': [{'name': 'command',
+    'type': 'STRING',
+    'description': 'Python code'},
+   {'name': 'timeout',
+    'type': 'NUMBER',
+    'description': 'Upper bound of waiting time for Python script execution.'}],
+  'required': ['command'],
+  'parameter_description': '如果调用该工具，你必须使用Json格式 {key: value} 传参，其中key为参数名称'}]
+```
+
+通过动作执行器来触发一个工具
+
+```python
+ret = executor('IPythonInterpreter', '{"command": "import math;math.sqrt(100)"}')
+ret.result
+```
+
+```python
+[{'type': 'text', 'content': '10.0'}]
+```

examples/.ipynb_checkpoints/agent_api_web_demo-checkpoint.py

@@ -0,0 +1,196 @@
+import copy
+import os
+from typing import List
+import streamlit as st
+from lagent.actions import ArxivSearch, WeatherQuery
+from lagent.prompts.parsers import PluginParser
+from lagent.agents.stream import INTERPRETER_CN, META_CN, PLUGIN_CN, AgentForInternLM, get_plugin_prompt
+from lagent.llms import GPTAPI
+
+class SessionState:
+    """管理会话状态的类。"""
+
+    def init_state(self):
+        """初始化会话状态变量。"""
+        st.session_state['assistant'] = []  # 助手消息历史
+        st.session_state['user'] = []  # 用户消息历史
+        # 初始化插件列表
+        action_list = [
+            ArxivSearch(),
+            WeatherQuery(),
+        ]
+        st.session_state['plugin_map'] = {action.name: action for action in action_list}
+        st.session_state['model_map'] = {}  # 存储模型实例
+        st.session_state['model_selected'] = None  # 当前选定模型
+        st.session_state['plugin_actions'] = set()  # 当前激活插件
+        st.session_state['history'] = []  # 聊天历史
+        st.session_state['api_base'] = None  # 初始化API base地址
+
+    def clear_state(self):
+        """清除当前会话状态。"""
+        st.session_state['assistant'] = []
+        st.session_state['user'] = []
+        st.session_state['model_selected'] = None
+
+
+class StreamlitUI:
+    """管理 Streamlit 界面的类。"""
+
+    def __init__(self, session_state: SessionState):
+        self.session_state = session_state
+        self.plugin_action = []  # 当前选定的插件
+        # 初始化提示词
+        self.meta_prompt = META_CN
+        self.plugin_prompt = PLUGIN_CN
+        self.init_streamlit()
+
+    def init_streamlit(self):
+        """初始化 Streamlit 的 UI 设置。"""
+     #   st.set_page_config(
+      #      layout='wide',
+       #     page_title='lagent-web',
+        #    page_icon='./docs/imgs/lagent_icon.png'
+       # )
+        st.header(':robot_face: :blue[Lagent] Web Demo ', divider='rainbow')
+
+    def setup_sidebar(self):
+        """设置侧边栏，选择模型和插件。"""
+        # 模型名称和 API Base 输入框
+        model_name = st.sidebar.text_input('模型名称：', value='internlm2.5-latest')
+        
+        # ================================== 硅基流动的API ==================================
+        # 注意，如果采用硅基流动API，模型名称需要更改为：internlm/internlm2_5-7b-chat 或者 internlm/internlm2_5-20b-chat
+        # api_base = st.sidebar.text_input(
+        #     'API Base 地址：', value='https://api.siliconflow.cn/v1/chat/completions'
+        # )
+        # ================================== 浦语官方的API ==================================
+        api_base = st.sidebar.text_input(
+            'API Base 地址：', value='https://internlm-chat.intern-ai.org.cn/puyu/api/v1/chat/completions'
+        )
+        # ==================================================================================
+        # 插件选择
+        plugin_name = st.sidebar.multiselect(
+            '插件选择',
+            options=list(st.session_state['plugin_map'].keys()),
+            default=[],
+        )
+
+        # 根据选择的插件生成插件操作列表
+        self.plugin_action = [st.session_state['plugin_map'][name] for name in plugin_name]
+
+        # 动态生成插件提示
+        if self.plugin_action:
+            self.plugin_prompt = get_plugin_prompt(self.plugin_action)
+
+        # 清空对话按钮
+        if st.sidebar.button('清空对话', key='clear'):
+            self.session_state.clear_state()
+
+        return model_name, api_base, self.plugin_action
+
+    def initialize_chatbot(self, model_name, api_base, plugin_action):
+        """初始化 GPTAPI 实例作为 chatbot。"""
+        token = os.getenv("token")
+        if not token:
+            st.error("未检测到环境变量 `token`，请设置环境变量，例如 `export token='your_token_here'` 后重新运行 X﹏X")
+            st.stop()  # 停止运行应用
+            
+        # 创建完整的 meta_prompt，保留原始结构并动态插入侧边栏配置
+        meta_prompt = [
+            {"role": "system", "content": self.meta_prompt, "api_role": "system"},
+            {"role": "user", "content": "", "api_role": "user"},
+            {"role": "assistant", "content": self.plugin_prompt, "api_role": "assistant"},
+            {"role": "environment", "content": "", "api_role": "environment"}
+        ]
+
+        api_model = GPTAPI(
+            model_type=model_name,
+            api_base=api_base,
+            key=token,  # 从环境变量中获取授权令牌
+            meta_template=meta_prompt,
+            max_new_tokens=512,
+            temperature=0.8,
+            top_p=0.9
+        )
+        return api_model
+
+    def render_user(self, prompt: str):
+        """渲染用户输入内容。"""
+        with st.chat_message('user'):
+            st.markdown(prompt)
+
+    def render_assistant(self, agent_return):
+        """渲染助手响应内容。"""
+        with st.chat_message('assistant'):
+            content = getattr(agent_return, "content", str(agent_return))
+            st.markdown(content if isinstance(content, str) else str(content))
+
+
+def main():
+    """主函数，运行 Streamlit 应用。"""
+    if 'ui' not in st.session_state:
+        session_state = SessionState()
+        session_state.init_state()
+        st.session_state['ui'] = StreamlitUI(session_state)
+    else:
+  #      st.set_page_config(
+  #          layout='wide',
+  #          page_title='lagent-web',
+  #          page_icon='./docs/imgs/lagent_icon.png'
+  #      )
+        st.header(':robot_face: :blue[Lagent] Web Demo ', divider='rainbow')
+
+    # 设置侧边栏并获取模型和插件信息
+    model_name, api_base, plugin_action = st.session_state['ui'].setup_sidebar()
+    plugins = [dict(type=f"lagent.actions.{plugin.__class__.__name__}") for plugin in plugin_action]
+
+    if (
+        'chatbot' not in st.session_state or
+        model_name != st.session_state['chatbot'].model_type or
+        'last_plugin_action' not in st.session_state or
+        plugin_action != st.session_state['last_plugin_action'] or
+        api_base != st.session_state['api_base']    
+    ):
+        # 更新 Chatbot
+        st.session_state['chatbot'] = st.session_state['ui'].initialize_chatbot(model_name, api_base, plugin_action)
+        st.session_state['last_plugin_action'] = plugin_action  # 更新插件状态
+        st.session_state['api_base'] = api_base  # 更新 API Base 地址
+
+        # 初始化 AgentForInternLM
+        st.session_state['agent'] = AgentForInternLM(
+            llm=st.session_state['chatbot'],
+            plugins=plugins,
+            output_format=dict(
+                type=PluginParser,
+                template=PLUGIN_CN,
+                prompt=get_plugin_prompt(plugin_action)
+            )
+        )
+        # 清空对话历史
+        st.session_state['session_history'] = []
+
+    if 'agent' not in st.session_state:
+        st.session_state['agent'] = None
+
+    agent = st.session_state['agent']
+    for prompt, agent_return in zip(st.session_state['user'], st.session_state['assistant']):
+        st.session_state['ui'].render_user(prompt)
+        st.session_state['ui'].render_assistant(agent_return)
+
+    # 处理用户输入
+    if user_input := st.chat_input(''):
+        st.session_state['ui'].render_user(user_input)
+
+        # 调用模型时确保侧边栏的系统提示词和插件提示词生效
+        res = agent(user_input, session_id=0)
+        st.session_state['ui'].render_assistant(res)
+
+        # 更新会话状态
+        st.session_state['user'].append(user_input)
+        st.session_state['assistant'].append(copy.deepcopy(res))
+
+    st.session_state['last_status'] = None
+
+
+if __name__ == '__main__':
+    main()

examples/.ipynb_checkpoints/multi_agents_api_web_demo-checkpoint.py

@@ -0,0 +1,198 @@
+import os
+import asyncio
+import json
+import re
+import requests
+import streamlit as st
+
+from lagent.agents import Agent
+from lagent.prompts.parsers import PluginParser
+from lagent.agents.stream import PLUGIN_CN, get_plugin_prompt
+from lagent.schema import AgentMessage
+from lagent.actions import ArxivSearch
+from lagent.hooks import Hook
+from lagent.llms import GPTAPI
+
+YOUR_TOKEN_HERE = os.getenv("token")
+if not YOUR_TOKEN_HERE:
+    raise EnvironmentError("未找到环境变量 'token'，请设置后再运行程序。")
+
+# Hook类，用于对消息添加前缀
+class PrefixedMessageHook(Hook):
+    def __init__(self, prefix, senders=None):
+        """
+        初始化Hook
+        :param prefix: 消息前缀
+        :param senders: 指定发送者列表
+        """
+        self.prefix = prefix
+        self.senders = senders or []
+
+    def before_agent(self, agent, messages, session_id):
+        """
+        在代理处理消息前修改消息内容
+        :param agent: 当前代理
+        :param messages: 消息列表
+        :param session_id: 会话ID
+        """
+        for message in messages:
+            if message.sender in self.senders:
+                message.content = self.prefix + message.content
+
+class AsyncBlogger:
+    """博客生成类，整合写作者和批评者。"""
+
+    def __init__(self, model_type, api_base, writer_prompt, critic_prompt, critic_prefix='', max_turn=2):
+        """
+        初始化博客生成器
+        :param model_type: 模型类型
+        :param api_base: API 基地址
+        :param writer_prompt: 写作者提示词
+        :param critic_prompt: 批评者提示词
+        :param critic_prefix: 批评消息前缀
+        :param max_turn: 最大轮次
+        """
+        self.model_type = model_type
+        self.api_base = api_base
+        self.llm = GPTAPI(
+            model_type=model_type,
+            api_base=api_base,
+            key=YOUR_TOKEN_HERE,
+            max_new_tokens=4096,
+        )
+        self.plugins = [dict(type='lagent.actions.ArxivSearch')]
+        self.writer = Agent(
+            self.llm,
+            writer_prompt,
+            name='写作者',
+            output_format=dict(
+                type=PluginParser,
+                template=PLUGIN_CN,
+                prompt=get_plugin_prompt(self.plugins)
+            )
+        )
+        self.critic = Agent(
+            self.llm,
+            critic_prompt,
+            name='批评者',
+            hooks=[PrefixedMessageHook(critic_prefix, ['写作者'])]
+        )
+        self.max_turn = max_turn
+
+    async def forward(self, message: AgentMessage, update_placeholder):
+        """
+        执行多阶段博客生成流程
+        :param message: 初始消息
+        :param update_placeholder: Streamlit占位符
+        :return: 最终优化的博客内容
+        """
+        step1_placeholder = update_placeholder.container()
+        step2_placeholder = update_placeholder.container()
+        step3_placeholder = update_placeholder.container()
+
+        # 第一步：生成初始内容
+        step1_placeholder.markdown("**Step 1: 生成初始内容...**")
+        message = self.writer(message)
+        if message.content:
+            step1_placeholder.markdown(f"**生成的初始内容**:\n\n{message.content}")
+        else:
+            step1_placeholder.markdown("**生成的初始内容为空，请检查生成逻辑。**")
+
+        # 第二步：批评者提供反馈
+        step2_placeholder.markdown("**Step 2: 批评者正在提供反馈和文献推荐...**")
+        message = self.critic(message)
+        if message.content:
+            # 解析批评者反馈
+            suggestions = re.search(r"1\. 批评建议：\n(.*?)2\. 推荐的关键词：", message.content, re.S)
+            keywords = re.search(r"2\. 推荐的关键词：\n- (.*)", message.content)
+            feedback = suggestions.group(1).strip() if suggestions else "未提供批评建议"
+            keywords = keywords.group(1).strip() if keywords else "未提供关键词"
+
+            # Arxiv 文献查询
+            arxiv_search = ArxivSearch()
+            arxiv_results = arxiv_search.get_arxiv_article_information(keywords)
+
+            # 显示批评内容和文献推荐
+            message.content = f"**批评建议**:\n{feedback}\n\n**推荐的文献**:\n{arxiv_results}"
+            step2_placeholder.markdown(f"**批评和文献推荐**:\n\n{message.content}")
+        else:
+            step2_placeholder.markdown("**批评内容为空，请检查批评逻辑。**")
+
+        # 第三步：写作者根据反馈优化内容
+        step3_placeholder.markdown("**Step 3: 根据反馈改进内容...**")
+        improvement_prompt = AgentMessage(
+            sender="critic",
+            content=(
+                f"根据以下批评建议和推荐文献对内容进行改进：\n\n"
+                f"批评建议：\n{feedback}\n\n"
+                f"推荐文献：\n{arxiv_results}\n\n"
+                f"请优化初始内容，使其更加清晰、丰富，并符合专业水准。"
+            ),
+        )
+        message = self.writer(improvement_prompt)
+        if message.content:
+            step3_placeholder.markdown(f"**最终优化的博客内容**:\n\n{message.content}")
+        else:
+            step3_placeholder.markdown("**最终优化的博客内容为空，请检查生成逻辑。**")
+
+        return message
+
+def setup_sidebar():
+    """设置侧边栏，选择模型。"""
+    model_name = st.sidebar.text_input('模型名称：', value='internlm2.5-latest')
+    api_base = st.sidebar.text_input(
+        'API Base 地址：', value='https://internlm-chat.intern-ai.org.cn/puyu/api/v1/chat/completions'
+    )
+    
+    return model_name, api_base
+    
+def main():
+    """
+    主函数：构建Streamlit界面并处理用户交互
+    """
+   # st.set_page_config(layout='wide', page_title='Lagent Web Demo', page_icon='🤖')
+    st.title("多代理博客优化助手")
+
+    model_type, api_base = setup_sidebar()
+    topic = st.text_input('输入一个话题：', 'Self-Supervised Learning')
+    generate_button = st.button('生成博客内容')
+
+    if (
+        'blogger' not in st.session_state or
+        st.session_state['model_type'] != model_type or
+        st.session_state['api_base'] != api_base
+    ):
+        st.session_state['blogger'] = AsyncBlogger(
+            model_type=model_type,
+            api_base=api_base,
+            writer_prompt="你是一位优秀的AI内容写作者，请撰写一篇有吸引力且信息丰富的博客内容。",
+            critic_prompt="""
+                作为一位严谨的批评者，请给出建设性的批评和改进建议，并基于相关主题使用已有的工具推荐一些参考文献，推荐的关键词应该是英语形式，简洁且切题。
+                请按照以下格式提供反馈：
+                1. 批评建议：
+                - （具体建议）
+                2. 推荐的关键词：
+                - （关键词1, 关键词2, ...）
+            """,
+            critic_prefix="请批评以下内容，并提供改进建议：\n\n"
+        )
+        st.session_state['model_type'] = model_type
+        st.session_state['api_base'] = api_base
+
+    if generate_button:
+        update_placeholder = st.empty()
+
+        async def run_async_blogger():
+            message = AgentMessage(
+                sender='user',
+                content=f"请撰写一篇关于{topic}的博客文章，要求表达专业，生动有趣，并且易于理解。"
+            )
+            result = await st.session_state['blogger'].forward(message, update_placeholder)
+            return result
+
+        loop = asyncio.new_event_loop()
+        asyncio.set_event_loop(loop)
+        loop.run_until_complete(run_async_blogger())
+
+if __name__ == '__main__':
+    main()

examples/agent_api_web_demo.py

@@ -0,0 +1,196 @@
+import copy
+import os
+from typing import List
+import streamlit as st
+from lagent.actions import ArxivSearch, WeatherQuery
+from lagent.prompts.parsers import PluginParser
+from lagent.agents.stream import INTERPRETER_CN, META_CN, PLUGIN_CN, AgentForInternLM, get_plugin_prompt
+from lagent.llms import GPTAPI
+
+class SessionState:
+    """管理会话状态的类。"""
+
+    def init_state(self):
+        """初始化会话状态变量。"""
+        st.session_state['assistant'] = []  # 助手消息历史
+        st.session_state['user'] = []  # 用户消息历史
+        # 初始化插件列表
+        action_list = [
+            ArxivSearch(),
+            WeatherQuery(),
+        ]
+        st.session_state['plugin_map'] = {action.name: action for action in action_list}
+        st.session_state['model_map'] = {}  # 存储模型实例
+        st.session_state['model_selected'] = None  # 当前选定模型
+        st.session_state['plugin_actions'] = set()  # 当前激活插件
+        st.session_state['history'] = []  # 聊天历史
+        st.session_state['api_base'] = None  # 初始化API base地址
+
+    def clear_state(self):
+        """清除当前会话状态。"""
+        st.session_state['assistant'] = []
+        st.session_state['user'] = []
+        st.session_state['model_selected'] = None
+
+
+class StreamlitUI:
+    """管理 Streamlit 界面的类。"""
+
+    def __init__(self, session_state: SessionState):
+        self.session_state = session_state
+        self.plugin_action = []  # 当前选定的插件
+        # 初始化提示词
+        self.meta_prompt = META_CN
+        self.plugin_prompt = PLUGIN_CN
+        self.init_streamlit()
+
+    def init_streamlit(self):
+        """初始化 Streamlit 的 UI 设置。"""
+     #   st.set_page_config(
+      #      layout='wide',
+       #     page_title='lagent-web',
+        #    page_icon='./docs/imgs/lagent_icon.png'
+       # )
+        st.header(':robot_face: :blue[Lagent] Web Demo ', divider='rainbow')
+
+    def setup_sidebar(self):
+        """设置侧边栏，选择模型和插件。"""
+        # 模型名称和 API Base 输入框
+        model_name = st.sidebar.text_input('模型名称：', value='internlm2.5-latest')
+        
+        # ================================== 硅基流动的API ==================================
+        # 注意，如果采用硅基流动API，模型名称需要更改为：internlm/internlm2_5-7b-chat 或者 internlm/internlm2_5-20b-chat
+        # api_base = st.sidebar.text_input(
+        #     'API Base 地址：', value='https://api.siliconflow.cn/v1/chat/completions'
+        # )
+        # ================================== 浦语官方的API ==================================
+        api_base = st.sidebar.text_input(
+            'API Base 地址：', value='https://internlm-chat.intern-ai.org.cn/puyu/api/v1/chat/completions'
+        )
+        # ==================================================================================
+        # 插件选择
+        plugin_name = st.sidebar.multiselect(
+            '插件选择',
+            options=list(st.session_state['plugin_map'].keys()),
+            default=[],
+        )
+
+        # 根据选择的插件生成插件操作列表
+        self.plugin_action = [st.session_state['plugin_map'][name] for name in plugin_name]
+
+        # 动态生成插件提示
+        if self.plugin_action:
+            self.plugin_prompt = get_plugin_prompt(self.plugin_action)
+
+        # 清空对话按钮
+        if st.sidebar.button('清空对话', key='clear'):
+            self.session_state.clear_state()
+
+        return model_name, api_base, self.plugin_action
+
+    def initialize_chatbot(self, model_name, api_base, plugin_action):
+        """初始化 GPTAPI 实例作为 chatbot。"""
+        token = os.getenv("token")
+        if not token:
+            st.error("未检测到环境变量 `token`，请设置环境变量，例如 `export token='your_token_here'` 后重新运行 X﹏X")
+            st.stop()  # 停止运行应用
+            
+        # 创建完整的 meta_prompt，保留原始结构并动态插入侧边栏配置
+        meta_prompt = [
+            {"role": "system", "content": self.meta_prompt, "api_role": "system"},
+            {"role": "user", "content": "", "api_role": "user"},
+            {"role": "assistant", "content": self.plugin_prompt, "api_role": "assistant"},
+            {"role": "environment", "content": "", "api_role": "environment"}
+        ]
+
+        api_model = GPTAPI(
+            model_type=model_name,
+            api_base=api_base,
+            key=token,  # 从环境变量中获取授权令牌
+            meta_template=meta_prompt,
+            max_new_tokens=512,
+            temperature=0.8,
+            top_p=0.9
+        )
+        return api_model
+
+    def render_user(self, prompt: str):
+        """渲染用户输入内容。"""
+        with st.chat_message('user'):
+            st.markdown(prompt)
+
+    def render_assistant(self, agent_return):
+        """渲染助手响应内容。"""
+        with st.chat_message('assistant'):
+            content = getattr(agent_return, "content", str(agent_return))
+            st.markdown(content if isinstance(content, str) else str(content))
+
+
+def main():
+    """主函数，运行 Streamlit 应用。"""
+    if 'ui' not in st.session_state:
+        session_state = SessionState()
+        session_state.init_state()
+        st.session_state['ui'] = StreamlitUI(session_state)
+    else:
+  #      st.set_page_config(
+  #          layout='wide',
+  #          page_title='lagent-web',
+  #          page_icon='./docs/imgs/lagent_icon.png'
+  #      )
+        st.header(':robot_face: :blue[Lagent] Web Demo ', divider='rainbow')
+
+    # 设置侧边栏并获取模型和插件信息
+    model_name, api_base, plugin_action = st.session_state['ui'].setup_sidebar()
+    plugins = [dict(type=f"lagent.actions.{plugin.__class__.__name__}") for plugin in plugin_action]
+
+    if (
+        'chatbot' not in st.session_state or
+        model_name != st.session_state['chatbot'].model_type or
+        'last_plugin_action' not in st.session_state or
+        plugin_action != st.session_state['last_plugin_action'] or
+        api_base != st.session_state['api_base']    
+    ):
+        # 更新 Chatbot
+        st.session_state['chatbot'] = st.session_state['ui'].initialize_chatbot(model_name, api_base, plugin_action)
+        st.session_state['last_plugin_action'] = plugin_action  # 更新插件状态
+        st.session_state['api_base'] = api_base  # 更新 API Base 地址
+
+        # 初始化 AgentForInternLM
+        st.session_state['agent'] = AgentForInternLM(
+            llm=st.session_state['chatbot'],
+            plugins=plugins,
+            output_format=dict(
+                type=PluginParser,
+                template=PLUGIN_CN,
+                prompt=get_plugin_prompt(plugin_action)
+            )
+        )
+        # 清空对话历史
+        st.session_state['session_history'] = []
+
+    if 'agent' not in st.session_state:
+        st.session_state['agent'] = None
+
+    agent = st.session_state['agent']
+    for prompt, agent_return in zip(st.session_state['user'], st.session_state['assistant']):
+        st.session_state['ui'].render_user(prompt)
+        st.session_state['ui'].render_assistant(agent_return)
+
+    # 处理用户输入
+    if user_input := st.chat_input(''):
+        st.session_state['ui'].render_user(user_input)
+
+        # 调用模型时确保侧边栏的系统提示词和插件提示词生效
+        res = agent(user_input, session_id=0)
+        st.session_state['ui'].render_assistant(res)
+
+        # 更新会话状态
+        st.session_state['user'].append(user_input)
+        st.session_state['assistant'].append(copy.deepcopy(res))
+
+    st.session_state['last_status'] = None
+
+
+if __name__ == '__main__':
+    main()