deploy: 527d274

en/_modules/agentscope/agents/agent.html

@@ -137,7 +137,7 @@ <h1>Source code for agentscope.agents.agent</h1><div class="highlight"><pre>
 
 
 <span class="k">class</span> <span class="nc">_AgentMeta</span><span class="p">(</span><span class="n">ABCMeta</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;The meta-class for agent.</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The metaclass for agent.</span>
 
 <span class="sd">    1. record the init args into `_init_settings` field.</span>
 <span class="sd">    2. register class name into `registry` field.</span>
@@ -364,7 +364,7 @@ <h1>Source code for agentscope.agents.agent</h1><div class="highlight"><pre>
 <span class="sd">            ValueError: Agent class name not exits.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            Type[AgentBase]: the AgentBase sub-class.</span>
+<span class="sd">            Type[AgentBase]: the AgentBase subclass.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="n">agent_class_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_registry</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Agent class &lt;</span><span class="si">{</span><span class="n">agent_class_name</span><span class="si">}</span><span class="s2">&gt; not found.&quot;</span><span class="p">)</span>

en/_modules/agentscope/models/litellm_model.html

@@ -127,11 +127,6 @@ <h1>Source code for agentscope.models.litellm_model</h1><div class="highlight"><
 <span class="kn">from</span> <span class="nn">..message</span> <span class="kn">import</span> <span class="n">Msg</span>
 <span class="kn">from</span> <span class="nn">..utils.tools</span> <span class="kn">import</span> <span class="n">_convert_to_str</span>
 
-<span class="k">try</span><span class="p">:</span>
-    <span class="kn">import</span> <span class="nn">litellm</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
-    <span class="n">litellm</span> <span class="o">=</span> <span class="kc">None</span>
-
 
 <div class="viewcode-block" id="LiteLLMWrapperBase">
 <a class="viewcode-back" href="../../../agentscope.models.litellm_model.html#agentscope.models.LiteLLMWrapperBase">[docs]</a>
@@ -180,16 +175,6 @@ <h1>Source code for agentscope.models.litellm_model</h1><div class="highlight"><
 
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">config_name</span><span class="o">=</span><span class="n">config_name</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="n">litellm</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
-                <span class="s2">&quot;Cannot import litellm package in current python environment.&quot;</span>
-                <span class="s2">&quot;You should try:&quot;</span>
-                <span class="s2">&quot;1. Install litellm by `pip install litellm`&quot;</span>
-                <span class="s2">&quot;2. If you still have import error, you should try to &quot;</span>
-                <span class="s2">&quot;update the openai to higher version, e.g. &quot;</span>
-                <span class="s2">&quot;by running `pip install openai==1.25.1&quot;</span><span class="p">,</span>
-            <span class="p">)</span>
-
         <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span> <span class="o">=</span> <span class="n">model_name</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">generate_args</span> <span class="o">=</span> <span class="n">generate_args</span> <span class="ow">or</span> <span class="p">{}</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_register_default_metrics</span><span class="p">()</span></div>
@@ -214,7 +199,7 @@ <h1>Source code for agentscope.models.litellm_model</h1><div class="highlight"><
 <a class="viewcode-back" href="../../../agentscope.models.litellm_model.html#agentscope.models.LiteLLMChatWrapper">[docs]</a>
 <span class="k">class</span> <span class="nc">LiteLLMChatWrapper</span><span class="p">(</span><span class="n">LiteLLMWrapperBase</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;The model wrapper based on litellm chat API.</span>
-<span class="sd">    To use the LiteLLM wrapper, environent variables must be set.</span>
+<span class="sd">    To use the LiteLLM wrapper, environment variables must be set.</span>
 <span class="sd">    Different model_name could be using different environment variables.</span>
 <span class="sd">    For example:</span>
 <span class="sd">        - for model_name: &quot;gpt-3.5-turbo&quot;, you need to set &quot;OPENAI_API_KEY&quot;</span>
@@ -338,6 +323,15 @@ <h1>Source code for agentscope.models.litellm_model</h1><div class="highlight"><
                 <span class="s2">&quot;and &#39;content&#39; key for LiteLLM API.&quot;</span><span class="p">,</span>
             <span class="p">)</span>
 
+        <span class="c1"># Import litellm only when it is used</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="kn">import</span> <span class="nn">litellm</span>
+        <span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
+                <span class="s2">&quot;Cannot find litellm in current environment, please &quot;</span>
+                <span class="s2">&quot;install it by `pip install litellm`.&quot;</span><span class="p">,</span>
+            <span class="p">)</span> <span class="kn">from</span> <span class="nn">e</span>
+
         <span class="c1"># step3: forward to generate response</span>
         <span class="k">if</span> <span class="n">stream</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="n">stream</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream</span>
@@ -428,7 +422,7 @@ <h1>Source code for agentscope.models.litellm_model</h1><div class="highlight"><
 <span class="sd">        Note that the format function might not be the optimal way to construct</span>
 <span class="sd">        prompt for every model, but a common way to do so.</span>
 <span class="sd">        Developers are encouraged to implement their own prompt</span>
-<span class="sd">        engineering strategies if have strong performance concerns.</span>
+<span class="sd">        engineering strategies if they have strong performance concerns.</span>
 
 <span class="sd">        Args:</span>
 <span class="sd">            args (`Union[Msg, Sequence[Msg]]`):</span>

en/_modules/agentscope/models/openai_model.html

@@ -131,11 +131,6 @@ <h1>Source code for agentscope.models.openai_model</h1><div class="highlight"><p
 <span class="kn">from</span> <span class="nn">..message</span> <span class="kn">import</span> <span class="n">Msg</span>
 <span class="kn">from</span> <span class="nn">..utils.tools</span> <span class="kn">import</span> <span class="n">_convert_to_str</span><span class="p">,</span> <span class="n">_to_openai_image_url</span>
 
-<span class="k">try</span><span class="p">:</span>
-    <span class="kn">import</span> <span class="nn">openai</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
-    <span class="n">openai</span> <span class="o">=</span> <span class="kc">None</span>
-
 <span class="kn">from</span> <span class="nn">..utils.token_utils</span> <span class="kn">import</span> <span class="n">get_openai_max_length</span>
 <span class="kn">from</span> <span class="nn">..constants</span> <span class="kn">import</span> <span class="n">_DEFAULT_API_BUDGET</span>
 
@@ -187,14 +182,17 @@ <h1>Source code for agentscope.models.openai_model</h1><div class="highlight"><p
 
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">config_name</span><span class="o">=</span><span class="n">config_name</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="n">openai</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
-                <span class="s2">&quot;Cannot find openai package in current python environment.&quot;</span><span class="p">,</span>
-            <span class="p">)</span>
-
         <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span> <span class="o">=</span> <span class="n">model_name</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">generate_args</span> <span class="o">=</span> <span class="n">generate_args</span> <span class="ow">or</span> <span class="p">{}</span>
 
+        <span class="k">try</span><span class="p">:</span>
+            <span class="kn">import</span> <span class="nn">openai</span>
+        <span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
+                <span class="s2">&quot;Cannot find openai package, please install it by &quot;</span>
+                <span class="s2">&quot;`pip install openai`&quot;</span><span class="p">,</span>
+            <span class="p">)</span> <span class="kn">from</span> <span class="nn">e</span>
+
         <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">openai</span><span class="o">.</span><span class="n">OpenAI</span><span class="p">(</span>
             <span class="n">api_key</span><span class="o">=</span><span class="n">api_key</span><span class="p">,</span>
             <span class="n">organization</span><span class="o">=</span><span class="n">organization</span><span class="p">,</span>

en/_modules/agentscope/rpc/rpc_agent_client.html

@@ -223,7 +223,7 @@ <h1>Source code for agentscope.rpc.rpc_agent_client</h1><div class="highlight"><
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Check if the agent server is alive.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            bool: Indecate whether the server is alive.</span>
+<span class="sd">            bool: Indicate whether the server is alive.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="k">try</span><span class="p">:</span>
@@ -283,7 +283,7 @@ <h1>Source code for agentscope.rpc.rpc_agent_client</h1><div class="highlight"><
 <span class="sd">            agent_id (`str`): agent_id of the created agent.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            bool: Indecate whether the creation is successful</span>
+<span class="sd">            bool: Indicate whether the creation is successful</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">try</span><span class="p">:</span>
             <span class="k">with</span> <span class="n">grpc</span><span class="o">.</span><span class="n">insecure_channel</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">channel</span><span class="p">:</span>
@@ -325,7 +325,7 @@ <h1>Source code for agentscope.rpc.rpc_agent_client</h1><div class="highlight"><
 <span class="sd">            agent_id (`str`): id of the agent to be deleted.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            bool: Indecate whether the deletion is successful</span>
+<span class="sd">            bool: Indicate whether the deletion is successful</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">with</span> <span class="n">grpc</span><span class="o">.</span><span class="n">insecure_channel</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">channel</span><span class="p">:</span>
             <span class="n">stub</span> <span class="o">=</span> <span class="n">RpcAgentStub</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span>
@@ -545,7 +545,7 @@ <h1>Source code for agentscope.rpc.rpc_agent_client</h1><div class="highlight"><
 
 <span class="sd">    Args:</span>
 <span class="sd">        client (`RpcAgentClient`): The rpc client.</span>
-<span class="sd">        x (`str`): The value of the reqeust.</span>
+<span class="sd">        value (`str`): The value of the request.</span>
 <span class="sd">        func_name (`str`): The name of the function being called.</span>
 
 <span class="sd">    Returns:</span>

en/_modules/agentscope/strategy/mixture_of_agent.html

@@ -165,7 +165,7 @@ <h1>Source code for agentscope.strategy.mixture_of_agent</h1><div class="highlig
 <span class="sd">                in each round.</span>
 <span class="sd">                Can take both config name of model or model instance as input.</span>
 <span class="sd">                We encourage using different models to get better diversity.</span>
-<span class="sd">                Emperically, responses generated by heterogeneous models</span>
+<span class="sd">                Empirically, responses generated by heterogeneous models</span>
 <span class="sd">                contribute more than those produced by the same model.</span>
 <span class="sd">            rounds (`int`):</span>
 <span class="sd">                The number of processing rounds to refine the responses.</span>

en/agentscope.agents.agent.html

@@ -216,7 +216,7 @@
 <dd class="field-even"><p><strong>ValueError</strong> – Agent class name not exits.</p>
 </dd>
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>the AgentBase sub-class.</p>
+<dd class="field-odd"><p>the AgentBase subclass.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p>Type[<a class="reference internal" href="#agentscope.agents.agent.AgentBase" title="agentscope.agents.agent.AgentBase">AgentBase</a>]</p>

en/agentscope.agents.html

@@ -288,7 +288,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd class="field-even"><p><strong>ValueError</strong> – Agent class name not exits.</p>
 </dd>
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>the AgentBase sub-class.</p>
+<dd class="field-odd"><p>the AgentBase subclass.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p>Type[<a class="reference internal" href="#agentscope.agents.AgentBase" title="agentscope.agents.AgentBase">AgentBase</a>]</p>

en/agentscope.models.html

@@ -1252,7 +1252,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">agentscope.models.</span></span><span class="sig-name descname"><span class="pre">LiteLLMChatWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_name</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">model_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">generate_args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/agentscope/models/litellm_model.html#LiteLLMChatWrapper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#agentscope.models.LiteLLMChatWrapper" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="agentscope.models.litellm_model.html#agentscope.models.litellm_model.LiteLLMWrapperBase" title="agentscope.models.litellm_model.LiteLLMWrapperBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">LiteLLMWrapperBase</span></code></a></p>
 <p>The model wrapper based on litellm chat API.
-To use the LiteLLM wrapper, environent variables must be set.
+To use the LiteLLM wrapper, environment variables must be set.
 Different model_name could be using different environment variables.
 For example:</p>
 <blockquote>
@@ -1315,7 +1315,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 Note that the format function might not be the optimal way to construct
 prompt for every model, but a common way to do so.
 Developers are encouraged to implement their own prompt
-engineering strategies if have strong performance concerns.</p>
+engineering strategies if they have strong performance concerns.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>args</strong> (<cite>Union[Msg, Sequence[Msg]]</cite>) – The input arguments to be formatted, where each argument