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

camel-docs-botb28faa2ce641
diff --git a/docs/reference/camel.societies.workforce.utils.md b/docs/reference/camel.societies.workforce.utils.md
new file mode 100644
index 000000000..d44c9ad17
--- /dev/null
+++ b/docs/reference/camel.societies.workforce.utils.md
@@ -0,0 +1,88 @@
+<a id="camel.societies.workforce.utils"></a>
+
+<a id="camel.societies.workforce.utils.WorkerConf"></a>
+
+## WorkerConf
+
+```python
+class WorkerConf(BaseModel):
+```
+
+The configuration of a worker.
+
+<a id="camel.societies.workforce.utils.TaskResult"></a>
+
+## TaskResult
+
+```python
+class TaskResult(BaseModel):
+```
+
+The result of a task.
+
+<a id="camel.societies.workforce.utils.TaskAssignment"></a>
+
+## TaskAssignment
+
+```python
+class TaskAssignment(BaseModel):
+```
+
+An individual task assignment within a batch.
+
+<a id="camel.societies.workforce.utils.TaskAssignment._split_and_strip"></a>
+
+### _split_and_strip
+
+```python
+def _split_and_strip(dep_str: str):
+```
+
+Utility to split a comma separated string and strip whitespace.
+
+<a id="camel.societies.workforce.utils.TaskAssignment.validate_dependencies"></a>
+
+### validate_dependencies
+
+```python
+def validate_dependencies(cls, v):
+```
+
+<a id="camel.societies.workforce.utils.TaskAssignResult"></a>
+
+## TaskAssignResult
+
+```python
+class TaskAssignResult(BaseModel):
+```
+
+The result of task assignment for both single and batch assignments.
+
+<a id="camel.societies.workforce.utils.check_if_running"></a>
+
+## check_if_running
+
+```python
+def check_if_running(
+ running: bool,
+ max_retries: int = 3,
+ retry_delay: float = 1.0,
+ handle_exceptions: bool = False
+):
+```
+
+Check if the workforce is (not) running, specified by the boolean
+value. Provides fault tolerance through automatic retries and exception
+handling.
+
+**Parameters:**
+
+- **running** (bool): Expected running state (True or False).
+- **max_retries** (int, optional): Maximum number of retry attempts if the operation fails. Set to 0 to disable retries. (default: :obj:`3`)
+- **retry_delay** (float, optional): Delay in seconds between retry attempts. (default: :obj:`1.0`)
+- **handle_exceptions** (bool, optional): If True, catch and log exceptions instead of propagating them. (default: :obj:`False`)
+
+**Raises:**
+
+- **RuntimeError**: If the workforce is not in the expected status and
+- **Exception**: Any exception raised by the decorated function if