mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-09-07 08:26:06 +00:00
docs(config): update documentation styling and logo
This commit is contained in:
dengjiaji
parent
7c07f58b81
commit
fdb242ff5d
5 changed files with 42 additions and 30 deletions
|
|
@ -2,9 +2,12 @@
|
|||
# Learn more at https://jupyterbook.org/customize/config.html
|
||||
|
||||
project: "ReMe"
|
||||
title: "<span style='font-weight: 700; color: #2196f3;'>ReMe</span> <br><span style='font-weight: 900; color: #ff5722;'></span>"
|
||||
title: "<div style='text-align:center'>
|
||||
<span style='font-weight:700;color:#2196f3;'>AgentScope</span><br>
|
||||
<span style='font-weight:900;color:#ff5722;'>ReMe</span>
|
||||
</div>"
|
||||
author: Alibaba Tongyi Lab
|
||||
logo: _static/figure/reme_logo.png
|
||||
logo: _static/figure/logo.svg
|
||||
copyright: "2025, Tongyi Lab, Alibaba Inc."
|
||||
only_build_toc_files: true
|
||||
|
||||
|
|
@ -31,6 +34,7 @@ html:
|
|||
- _static/memory-lib/memory-lib.js
|
||||
extra_css:
|
||||
- _static/memory-lib/memory-lib.css
|
||||
- _static/custom.css
|
||||
|
||||
# Sphinx settings
|
||||
sphinx:
|
||||
|
|
@ -40,6 +44,7 @@ sphinx:
|
|||
- sphinx.ext.napoleon
|
||||
- sphinx.ext.intersphinx
|
||||
- sphinx.ext.autosummary
|
||||
- sphinxcontrib.mermaid
|
||||
config:
|
||||
# API Documentation Configuration
|
||||
autosummary_generate: True
|
||||
|
|
@ -86,7 +91,6 @@ sphinx:
|
|||
use_multitoc_numbering: false
|
||||
html_js_files:
|
||||
- language.js
|
||||
|
||||
html_css_files:
|
||||
- custom.css
|
||||
html_sidebars:
|
||||
|
|
@ -103,6 +107,14 @@ sphinx:
|
|||
source_repository: "https://github.com/modelscope/ReMe"
|
||||
source_branch: "main"
|
||||
source_directory: "docs/"
|
||||
footer_icons:
|
||||
- name: GitHub
|
||||
url: "https://github.com/modelscope/ReMe"
|
||||
html: |
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
|
||||
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
|
||||
</svg>
|
||||
class: ""
|
||||
light_css_variables:
|
||||
color-brand-primary: "#2196f3"
|
||||
color-brand-content: "#2196f3"
|
||||
|
|
|
|||
12
docs/_static/custom.css
vendored
12
docs/_static/custom.css
vendored
|
|
@ -20,4 +20,14 @@ h5, .bd-article h5 {
|
|||
|
||||
h6, .bd-article h6 {
|
||||
font-size: 0.9rem !important;
|
||||
}
|
||||
}
|
||||
|
||||
div.bd-sidebar .navbar-brand {
|
||||
text-align: center;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bd-sidebar .navbar-brand span {
|
||||
display: block;
|
||||
text-align: center;
|
||||
}
|
||||
|
|
|
|||
1
docs/_static/figure/logo.svg
vendored
Normal file
1
docs/_static/figure/logo.svg
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="none" version="1.1" width="550" height="550" viewBox="0 0 550 550"><defs><linearGradient x1="0.01500389538705349" y1="0.4831196665763855" x2="0.9407116114637801" y2="0.3076102348892569" id="master_svg0_8_2390"><stop offset="0%" stop-color="#01C5FF" stop-opacity="1"/><stop offset="100%" stop-color="#019DFB" stop-opacity="1"/></linearGradient><linearGradient x1="0.21085502207279205" y1="0.38703426718711853" x2="0.9523109409029081" y2="0.390888421140005" id="master_svg1_8_1638"><stop offset="0%" stop-color="#4701EF" stop-opacity="1"/><stop offset="100%" stop-color="#395EEF" stop-opacity="1"/></linearGradient></defs><g><g></g><g><g><path d="M275.4998779296875,211.25Q275.4998779296875,279.5,373.4999779296875,310.5Q338.4998779296875,287.5,343.9998779296875,232Q344.4969779296875,227.19400000000002,345.9004779296875,222.498Q352.96577792968753,198.857,382.9998779296875,178L415.9998779296875,193.5L469.7738779296875,193.5C477.0958779296875,193.5,481.9218779296875,185.91559999999998,478.3148779296875,179.543Q441.5068779296875,114.5,372.9998779296875,114.5C343.9998779296875,114.5,275.4998779296875,143,275.4998779296875,211.25Z" fill="url(#master_svg0_8_2390)" fill-opacity="1"/></g><g><path d="M343.9999162890625,231.99999791015625Q337.9999162890625,287.5000079101562,373.5000462890625,310.5000079101562L433.4998462890625,333.00010791015626Q449.4994462890625,314.2500079101562,449.4994462890625,295.5000079101562Q449.4994462890625,276.7500079101562,433.4998462890625,258.0000079101562L345.9004862890625,222.49810791015625Q344.4970462890625,227.19412791015625,343.9999162890625,231.99999791015625Z" fill="#0064FC" fill-opacity="1"/></g><g><path d="M122.9998779296875,351.5C124.3900479296875,350.6567,125.7727179296875,349.8325,127.1479779296875,349.0269Q125.0392779296875,350.2098,122.9998779296875,351.5ZM127.1479779296875,349.0269Q150.3716779296875,336,181.9998779296875,336C186.2692779296875,335.7983,190.4211779296875,335.9808,194.4638779296875,336.502C250.5488779296875,343.7327,285.6218779296875,416.14300000000003,321.9998779296875,432Q350.1248779296875,444,377.9998779296875,444Q405.8748779296875,444,433.4998779296875,432Q489.9998779296875,400,489.9998779296875,344.5Q489.9998779296875,283,433.4998779296875,258Q449.4998779296875,276.75,449.4998779296875,295.5Q449.4998779296875,314.25,433.4998779296875,333C394.3168779296875,374.257,360.65987792968747,359.947,319.4498779296875,342.4251C286.9518779296875,328.6077,249.7568779296875,312.7935,201.4527779296875,320.6594C179.2413779296875,324.2763,154.6808779296875,332.9,127.1479779296875,349.0269Z" fill="url(#master_svg1_8_1638)" fill-opacity="1"/></g><g><path d="M61,437.99973876953123L133.8305,437.99973876953123C141.5661,437.99973876953123,148.608,433.53913876953123,151.9131,426.54513876953126L194.464,336.50202976953125C190.421,335.98083496953126,186.269,335.79829376953126,182,335.99999996953125Q147.4999,335.99999996953125,122.9999,351.5000387695313C93.5,373.5000387695313,87,387.0000387695313,61,437.99973876953123Z" fill="#0064FC" fill-opacity="1"/></g><g><path d="M61,438.00038301849366C87,387.00038301849366,93.5,373.50038301849366,122.9999,351.50038301849366C152.2215,333.77438301849367,178.132,324.45738301849366,201.453,320.65938301849366L256.597,207.04148301849364C259.081,201.92438301849364,259.26800000000003,195.99188301849364,257.11199999999997,190.72838301849367L227.948,119.52337301849366C225.653,113.91851301849366,217.805,113.67667301849366,215.169,119.12954301849365L61,438.00038301849366Z" fill="#01C8FF" fill-opacity="1"/></g></g></g></svg>
|
||||
|
After Width: | Height: | Size: 3.5 KiB |
|
|
@ -59,9 +59,8 @@ response = requests.post("http://localhost:8002/retrieve_task_memory", json={
|
|||
})
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>curl version</summary>
|
||||
|
||||
````{dropdown} curl version
|
||||
```bash
|
||||
# Experience Summarizer: Learn from execution trajectories
|
||||
curl -X POST http://localhost:8002/summary_task_memory \
|
||||
|
|
@ -82,12 +81,9 @@ curl -X POST http://localhost:8002/retrieve_task_memory \
|
|||
"top_k": 1
|
||||
}'
|
||||
```
|
||||
````
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Node.js version</summary>
|
||||
|
||||
````{dropdown} Node.js version
|
||||
```{code-block} javascript
|
||||
// Experience Summarizer: Learn from execution trajectories
|
||||
fetch("http://localhost:8002/summary_task_memory", {
|
||||
|
|
@ -120,8 +116,7 @@ fetch("http://localhost:8002/retrieve_task_memory", {
|
|||
.then(response => response.json())
|
||||
.then(data => console.log(data));
|
||||
```
|
||||
|
||||
</details>
|
||||
````
|
||||
|
||||
#### Personal Memory Management
|
||||
|
||||
|
|
@ -148,8 +143,7 @@ response = requests.post("http://localhost:8002/retrieve_personal_memory", json=
|
|||
})
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>curl version</summary>
|
||||
````{dropdown} curl version
|
||||
|
||||
```bash
|
||||
# Memory Integration: Learn from user interactions
|
||||
|
|
@ -174,11 +168,9 @@ curl -X POST http://localhost:8002/retrieve_personal_memory \
|
|||
"top_k": 5
|
||||
}'
|
||||
```
|
||||
````
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Node.js version</summary>
|
||||
````{dropdown} Node.js version
|
||||
|
||||
```{code-block} javascript
|
||||
// Memory Integration: Learn from user interactions
|
||||
|
|
@ -215,8 +207,8 @@ fetch("http://localhost:8002/retrieve_personal_memory", {
|
|||
.then(response => response.json())
|
||||
.then(data => console.log(data));
|
||||
```
|
||||
````
|
||||
|
||||
</details>
|
||||
|
||||
#### Tool Memory Management
|
||||
|
||||
|
|
@ -252,8 +244,8 @@ response = requests.post("http://localhost:8002/retrieve_tool_memory", json={
|
|||
})
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>curl version</summary>
|
||||
|
||||
````{dropdown} curl version
|
||||
|
||||
```bash
|
||||
# Record tool execution results
|
||||
|
|
@ -290,11 +282,9 @@ curl -X POST http://localhost:8002/retrieve_tool_memory \
|
|||
"tool_names": "web_search"
|
||||
}'
|
||||
```
|
||||
````
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Node.js version</summary>
|
||||
````{dropdown} Node.js version
|
||||
|
||||
```{code-block} javascript
|
||||
// Record tool execution results
|
||||
|
|
@ -349,5 +339,4 @@ fetch("http://localhost:8002/retrieve_tool_memory", {
|
|||
.then(response => response.json())
|
||||
.then(data => console.log(data));
|
||||
```
|
||||
|
||||
</details>
|
||||
````
|
||||
|
|
@ -191,7 +191,7 @@ class ToolCallResult(BaseModel):
|
|||
|
||||
### Tool Memory Lifecycle
|
||||
|
||||
```mermaid
|
||||
```{mermaid}
|
||||
graph LR
|
||||
A[Tool Call] --> B[Evaluate]
|
||||
B --> C[Store Memory]
|
||||
|
|
@ -206,7 +206,7 @@ graph LR
|
|||
|
||||
Tool Memory operates through three complementary operations that work together to create a learning loop:
|
||||
|
||||
```mermaid
|
||||
```{mermaid}
|
||||
graph LR
|
||||
A[Agent] -->|1 retrieve_tool_memory| B[(Vector Store)]
|
||||
B -->|Guidelines| A
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue