Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Auto-update documentation after merge [skip ci]

camel-docs-bot12703521c324
diff --git a/docs/mintlify/reference/camel.runtimes.base.mdx b/docs/mintlify/reference/camel.runtimes.base.mdx
index b7c4d9269..ccdcff198 100644
--- a/docs/mintlify/reference/camel.runtimes.base.mdx
+++ b/docs/mintlify/reference/camel.runtimes.base.mdx
@@ -43,6 +43,58 @@ def reset(self, *args: Any, **kwargs: Any):
Resets the runtime to its initial state.
+<a id="camel.runtimes.base.BaseRuntime.cleanup"></a>
+
+### cleanup
+
+```python
+def cleanup(self):
+```
+
+Releases resources (containers, processes, connections, etc.).
+
+Public part of the runtime lifecycle API: callers may call
+:meth:`cleanup` or use the runtime as a context manager
+(`__INLINE_CODE_1__`) for deterministic teardown. Subclasses must
+implement this method.
+
+<a id="camel.runtimes.base.BaseRuntime.stop"></a>
+
+### stop
+
+```python
+def stop(self):
+```
+
+**Returns:**
+
+ BaseRuntime: The current runtime (for chaining).
+
+<a id="camel.runtimes.base.BaseRuntime.__enter__"></a>
+
+### __enter__
+
+```python
+def __enter__(self):
+```
+
+Enter the context manager.
+
+<a id="camel.runtimes.base.BaseRuntime.__exit__"></a>
+
+### __exit__
+
+```python
+def __exit__(
+ self,
+ exc_type: type[BaseException] | None,
+ exc_val: BaseException | None,
+ exc_tb: Any | None
+):
+```
+
+Exit the context manager; ensures cleanup is called.
+
<a id="camel.runtimes.base.BaseRuntime.get_tools"></a>
### get_tools
diff --git a/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx b/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx
index 34c243251..33767413a 100644
--- a/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx
+++ b/docs/mintlify/reference/camel.runtimes.daytona_runtime.mdx
@@ -44,15 +44,15 @@ def build(self):
DaytonaRuntime: The current runtime.
-<a id="camel.runtimes.daytona_runtime.DaytonaRuntime._cleanup"></a>
+<a id="camel.runtimes.daytona_runtime.DaytonaRuntime.cleanup"></a>
-### _cleanup
+### cleanup
```python
-def _cleanup(self):
+def cleanup(self):
```
-Clean up the sandbox when exiting.
+Release the Daytona sandbox (delete and remove reference).
<a id="camel.runtimes.daytona_runtime.DaytonaRuntime.add"></a>
diff --git a/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx b/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx
index 85d58534f..ee4bd404d 100644
--- a/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx
+++ b/docs/mintlify/reference/camel.runtimes.docker_runtime.mdx
@@ -173,6 +173,20 @@ def reset(self):
DockerRuntime: The DockerRuntime instance.
+<a id="camel.runtimes.docker_runtime.DockerRuntime.cleanup"></a>
+
+### cleanup
+
+```python
+def cleanup(self):
+```
+
+Stop and optionally remove the Docker container.
+
+Uses the instance's :attr:`remove` setting to decide whether to
+remove the container after stopping. For a one-off override,
+use :meth:`stop` with the `__INLINE_CODE_2__` argument.
+
<a id="camel.runtimes.docker_runtime.DockerRuntime.stop"></a>
### stop
@@ -181,11 +195,11 @@ def reset(self):
def stop(self, remove: Optional[bool] = None):
```
-stop the Docker container.
+Stop the Docker container and release resources.
**Parameters:**
-- **remove** (Optional[bool]): Whether to remove the container after stopping it. (default: :obj:`None`)
+- **remove** (Optional[bool]): If set, overrides the instance's :attr:`remove` setting for this call only (e.g. `__INLINE_CODE_1____INLINE_CODE_2__None`)
**Returns:**
diff --git a/docs/mintlify/reference/camel.runtimes.llm_guard_runtime.mdx b/docs/mintlify/reference/camel.runtimes.llm_guard_runtime.mdx
index 15c64ceb1..c4e0456ac 100644
--- a/docs/mintlify/reference/camel.runtimes.llm_guard_runtime.mdx
+++ b/docs/mintlify/reference/camel.runtimes.llm_guard_runtime.mdx
@@ -53,6 +53,16 @@ Add a function or list of functions to the runtime.
LLMGuardRuntime: The current runtime.
+<a id="camel.runtimes.llm_guard_runtime.LLMGuardRuntime.cleanup"></a>
+
+### cleanup
+
+```python
+def cleanup(self):
+```
+
+No-op; LLMGuardRuntime does not hold external resources.
+
<a id="camel.runtimes.llm_guard_runtime.LLMGuardRuntime.reset"></a>
### reset
diff --git a/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx b/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx
index 91f19a909..01d32c79f 100644
--- a/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx
+++ b/docs/mintlify/reference/camel.runtimes.remote_http_runtime.mdx
@@ -42,15 +42,15 @@ def build(self):
RemoteHttpRuntime: The current runtime.
-<a id="camel.runtimes.remote_http_runtime.RemoteHttpRuntime._cleanup"></a>
+<a id="camel.runtimes.remote_http_runtime.RemoteHttpRuntime.cleanup"></a>
-### _cleanup
+### cleanup
```python
-def _cleanup(self):
+def cleanup(self):
```
-Clean up the API server when exiting.
+Stop and release the API server process.
<a id="camel.runtimes.remote_http_runtime.RemoteHttpRuntime.add"></a>