Skip to content

Commit

Permalink
deploy: d04a689
Browse files Browse the repository at this point in the history
  • Loading branch information
@binary-husky
binary-husky committed Sep 12, 2024
1 parent c6e005e commit 4562961
Show file tree
Hide file tree
Showing 22 changed files with 35 additions and 34 deletions.
Binary file modified en/.doctrees/docs/installation.doctree
View file
Binary file not shown.
Binary file modified en/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified en/.doctrees/memoryscope.core.utils.doctree
View file
Binary file not shown.
Binary file modified en/.doctrees/memoryscope.core.utils.tool_functions.doctree
View file
Binary file not shown.
8 changes: 4 additions & 4 deletions en/_sources/docs/installation.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing MemoryScope

## I. Install with docker [Recommended]
## I. Install with docker [Recommended] [x86_64]

1. Clone the repository and edit settings
```bash
Expand All @@ -16,13 +16,13 @@
sudo docker build --network=host -t memoryscope .
```

3. Launch Docker container
3. Launch Docker container (ARM architecture not yet supported)
```bash
sudo docker run -it --rm --net=host memoryscope
```


## II. Install with docker compose [Recommended]
## II. Install with docker compose [Recommended] [x86_64]

1. Clone the repository and edit settings
```bash
Expand All @@ -38,7 +38,7 @@
OPENAI_API_KEY: "sk-0000000000"
```

3. Run `docker-compose run memory_scope_main` to build and launch the memory-scope cli interface.
3. Run `docker-compose run memory_scope_main` to build and launch the memory-scope cli interface. (ARM architecture not yet supported)


## III. Install from PyPI
Expand Down
16 changes: 8 additions & 8 deletions en/docs/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">About MemoryScope</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#i-install-with-docker-recommended">I. Install with docker [Recommended]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ii-install-with-docker-compose-recommended">II. Install with docker compose [Recommended]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#i-install-with-docker-recommended-x86-64">I. Install with docker [Recommended] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ii-install-with-docker-compose-recommended-x86-64">II. Install with docker compose [Recommended] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#iii-install-from-pypi">III. Install from PyPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="#iv-install-from-source">IV. Install from source</a></li>
</ul>
Expand Down Expand Up @@ -106,8 +106,8 @@

<section id="installing-memoryscope">
<h1>Installing MemoryScope<a class="headerlink" href="#installing-memoryscope" title="Link to this heading"></a></h1>
<section id="i-install-with-docker-recommended">
<h2>I. Install with docker [Recommended]<a class="headerlink" href="#i-install-with-docker-recommended" title="Link to this heading"></a></h2>
<section id="i-install-with-docker-recommended-x86-64">
<h2>I. Install with docker [Recommended] [x86_64]<a class="headerlink" href="#i-install-with-docker-recommended-x86-64" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>Clone the repository and edit settings</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># clone project</span>
Expand All @@ -123,15 +123,15 @@ <h2>I. Install with docker [Recommended]<a class="headerlink" href="#i-install-w
</pre></div>
</div>
</li>
<li><p>Launch Docker container</p>
<li><p>Launch Docker container (ARM architecture not yet supported)</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>--net<span class="o">=</span>host<span class="w"> </span>memoryscope
</pre></div>
</div>
</li>
</ol>
</section>
<section id="ii-install-with-docker-compose-recommended">
<h2>II. Install with docker compose [Recommended]<a class="headerlink" href="#ii-install-with-docker-compose-recommended" title="Link to this heading"></a></h2>
<section id="ii-install-with-docker-compose-recommended-x86-64">
<h2>II. Install with docker compose [Recommended] [x86_64]<a class="headerlink" href="#ii-install-with-docker-compose-recommended-x86-64" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>Clone the repository and edit settings</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># clone project</span>
Expand All @@ -147,7 +147,7 @@ <h2>II. Install with docker compose [Recommended]<a class="headerlink" href="#ii
</pre></div>
</div>
</li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">run</span> <span class="pre">memory_scope_main</span></code> to build and launch the memory-scope cli interface.</p></li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">run</span> <span class="pre">memory_scope_main</span></code> to build and launch the memory-scope cli interface. (ARM architecture not yet supported)</p></li>
</ol>
</section>
<section id="iii-install-from-pypi">
Expand Down
4 changes: 2 additions & 2 deletions en/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ <h3>Framework<a class="headerlink" href="#framework" title="Link to this heading
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#i-install-with-docker-recommended">I. Install with docker [Recommended]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#ii-install-with-docker-compose-recommended">II. Install with docker compose [Recommended]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#i-install-with-docker-recommended-x86-64">I. Install with docker [Recommended] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#ii-install-with-docker-compose-recommended-x86-64">II. Install with docker compose [Recommended] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#iii-install-from-pypi">III. Install from PyPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#iv-install-from-source">IV. Install from source</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion en/memoryscope.core.utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -899,7 +899,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py function">
<dt class="sig sig-object py" id="memoryscope.core.utils.char_logo">
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726128809064452680</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.char_logo" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726133565202627749</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.char_logo" title="Link to this definition"></a></dt>
<dd><p>Render the context of logo with colors</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion en/memoryscope.core.utils.tool_functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="memoryscope.core.utils.tool_functions.char_logo">
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.tool_functions.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726128809064452680</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.tool_functions.char_logo" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.tool_functions.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726133565202627749</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.tool_functions.char_logo" title="Link to this definition"></a></dt>
<dd><p>Render the context of logo with colors</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Binary file modified en/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion en/searchindex.js
View file

Large diffs are not rendered by default.

Binary file modified zh/.doctrees/docs/installation.doctree
View file
Binary file not shown.
Binary file modified zh/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified zh/.doctrees/memoryscope.core.utils.doctree
View file
Binary file not shown.
Binary file modified zh/.doctrees/memoryscope.core.utils.tool_functions.doctree
View file
Binary file not shown.
9 changes: 5 additions & 4 deletions zh/_sources/docs/installation.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MemoryScope 安装指南

## 一、使用 Docker 安装 [推荐]
## 一、使用 Docker 安装 [推荐] [x86_64]

1. 克隆仓库并编辑配置
```bash
Expand All @@ -16,13 +16,14 @@
sudo docker build --network=host -t memoryscope .
```

3. 启动 Docker 容器
3. 启动 Docker 容器 (备注：ARM架构暂不支持)
```bash
sudo docker run -it --rm --net=host memoryscope
```


## 二、使用 Docker Compose 安装 [推荐]

## 二、使用 Docker Compose 安装 [推荐] [x86_64]

1. 克隆仓库并编辑配置
```bash
Expand All @@ -38,7 +39,7 @@
DASHSCOPE_API_KEY: "sk-0000000000"
```

3. 运行 `docker-compose run memory_scope_main` 命令来构建并启动 MemoryScope CLI 界面。
3. 运行 `docker-compose run memory_scope_main` 命令来构建并启动 MemoryScope CLI 界面。 (备注：ARM架构暂不支持)


## 三、通过 PYPI 安装
Expand Down
16 changes: 8 additions & 8 deletions zh/docs/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">关于 MemoryScope</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">安装</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#docker">一、使用 Docker 安装 [推荐]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#docker-compose">二、使用 Docker Compose 安装 [推荐]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#docker-x86-64">一、使用 Docker 安装 [推荐] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#docker-compose-x86-64">二、使用 Docker Compose 安装 [推荐] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pypi">三、通过 PYPI 安装</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">四、从源码安装</a></li>
</ul>
Expand Down Expand Up @@ -106,8 +106,8 @@

<section id="memoryscope">
<h1>MemoryScope 安装指南<a class="headerlink" href="#memoryscope" title="Link to this heading"></a></h1>
<section id="docker">
<h2>一、使用 Docker 安装 [推荐]<a class="headerlink" href="#docker" title="Link to this heading"></a></h2>
<section id="docker-x86-64">
<h2>一、使用 Docker 安装 [推荐] [x86_64]<a class="headerlink" href="#docker-x86-64" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>克隆仓库并编辑配置</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># 克隆项目</span>
Expand All @@ -123,15 +123,15 @@ <h2>一、使用 Docker 安装 [推荐]<a class="headerlink" href="#docker" titl
</pre></div>
</div>
</li>
<li><p>启动 Docker 容器</p>
<li><p>启动 Docker 容器 (备注：ARM架构暂不支持)</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--rm<span class="w"> </span>--net<span class="o">=</span>host<span class="w"> </span>memoryscope
</pre></div>
</div>
</li>
</ol>
</section>
<section id="docker-compose">
<h2>二、使用 Docker Compose 安装 [推荐]<a class="headerlink" href="#docker-compose" title="Link to this heading"></a></h2>
<section id="docker-compose-x86-64">
<h2>二、使用 Docker Compose 安装 [推荐] [x86_64]<a class="headerlink" href="#docker-compose-x86-64" title="Link to this heading"></a></h2>
<ol class="arabic">
<li><p>克隆仓库并编辑配置</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># 克隆项目</span>
Expand All @@ -147,7 +147,7 @@ <h2>二、使用 Docker Compose 安装 [推荐]<a class="headerlink" href="#dock
</pre></div>
</div>
</li>
<li><p>运行 <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">run</span> <span class="pre">memory_scope_main</span></code> 命令来构建并启动 MemoryScope CLI 界面。</p></li>
<li><p>运行 <code class="docutils literal notranslate"><span class="pre">docker-compose</span> <span class="pre">run</span> <span class="pre">memory_scope_main</span></code> 命令来构建并启动 MemoryScope CLI 界面。 (备注：ARM架构暂不支持)</p></li>
</ol>
</section>
<section id="pypi">
Expand Down
4 changes: 2 additions & 2 deletions zh/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ <h3>核心框架<a class="headerlink" href="#id2" title="Link to this heading">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/installation.html">安装</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#docker">一、使用 Docker 安装 [推荐]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#docker-compose">二、使用 Docker Compose 安装 [推荐]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#docker-x86-64">一、使用 Docker 安装 [推荐] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#docker-compose-x86-64">二、使用 Docker Compose 安装 [推荐] [x86_64]</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#pypi">三、通过 PYPI 安装</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/installation.html#id1">四、从源码安装</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion zh/memoryscope.core.utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -899,7 +899,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py function">
<dt class="sig sig-object py" id="memoryscope.core.utils.char_logo">
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726128829677690475</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.char_logo" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">memoryscope.core.utils.</span></span><span class="sig-name descname"><span class="pre">char_logo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">words</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1726133587483093787</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/memoryscope/core/utils/tool_functions.html#char_logo"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#memoryscope.core.utils.char_logo" title="Link to this definition"></a></dt>
<dd><p>Render the context of logo with colors</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
Expand Down
Loading

0 comments on commit 4562961

Please sign in to comment.