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-bot3d99f14fb32b
diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json
index 6606e3c16..dc2c48dc7 100644
--- a/docs/mintlify/docs.json
+++ b/docs/mintlify/docs.json
@@ -219,6 +219,7 @@
"group": "Configs",
"pages": [
"reference/camel.configs.aiml_config",
+ "reference/camel.configs.amd_config",
"reference/camel.configs.anthropic_config",
"reference/camel.configs.base_config",
"reference/camel.configs.bedrock_config",
@@ -298,6 +299,7 @@
"pages": [
"reference/camel.models._utils",
"reference/camel.models.aiml_model",
+ "reference/camel.models.amd_model",
"reference/camel.models.anthropic_model",
"reference/camel.models.aws_bedrock_model",
"reference/camel.models.azure_openai_model",
diff --git a/docs/mintlify/reference/camel.configs.amd_config.mdx b/docs/mintlify/reference/camel.configs.amd_config.mdx
new file mode 100644
index 000000000..7f06811e8
--- /dev/null
+++ b/docs/mintlify/reference/camel.configs.amd_config.mdx
@@ -0,0 +1,29 @@
+<a id="camel.configs.amd_config"></a>
+
+<a id="camel.configs.amd_config.AMDConfig"></a>
+
+## AMDConfig
+
+```python
+class AMDConfig(BaseConfig):
+```
+
+Configuration class for AMD API models.
+
+This class defines the configuration parameters for AMD's language
+models, including temperature, sampling parameters, and response format
+settings.
+
+**Parameters:**
+
+- **stream** (bool, optional): Whether to stream the response. (default: :obj:`None`)
+- **temperature** (float, optional): Controls randomness in the response. Higher values make output more random, lower values make it more deterministic. Range: [0.0, 2.0]. (default: :obj:`None`)
+- **top_p** (float, optional): Controls diversity via nucleus sampling.
+- **Range**: [0.0, 1.0]. (default: :obj:`None`)
+- **presence_penalty** (float, optional): Penalizes new tokens based on whether they appear in the text so far. Range: [-2.0, 2.0]. (default: :obj:`None`)
+- **frequency_penalty** (float, optional): Penalizes new tokens based on their frequency in the text so far. Range: [-2.0, 2.0]. (default: :obj:`None`)
+- **max_tokens** (Union[int, NotGiven], optional): Maximum number of tokens to generate. If not provided, model will use its default maximum. (default: :obj:`None`)
+- **seed** (Optional[int], optional): Random seed for deterministic sampling. (default: :obj:`None`)
+- **tools** (Optional[List[Dict]], optional): List of tools available to the model. This includes tools such as a text editor, a calculator, or a search engine. (default: :obj:`None`)
+- **tool_choice** (Optional[str], optional): Tool choice configuration. (default: :obj:`None`)
+- **stop** (Optional[List[str]], optional): List of stop sequences. (default: :obj:`None`)
diff --git a/docs/mintlify/reference/camel.models.amd_model.mdx b/docs/mintlify/reference/camel.models.amd_model.mdx
new file mode 100644
index 000000000..0a52d841b
--- /dev/null
+++ b/docs/mintlify/reference/camel.models.amd_model.mdx
@@ -0,0 +1,47 @@
+<a id="camel.models.amd_model"></a>
+
+<a id="camel.models.amd_model.AMDModel"></a>
+
+## AMDModel
+
+```python
+class AMDModel(OpenAICompatibleModel):
+```
+
+AMD API in a unified OpenAICompatibleModel interface.
+
+**Parameters:**
+
+- **model_type** (Union[ModelType, str]): Model for which a backend is created, one of AMD series.
+- **model_config_dict** (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:`openai.ChatCompletion.create()`. If :obj:`None`, :obj:`AMDConfig().as_dict()` will be used. (default: :obj:`None`)
+- **api_key** (Optional[str], optional): The API key for authenticating with the AMD service. (default: :obj:`None`)
+- **url** (Optional[str], optional): The url to the AMD service. (default: :obj:`None`)
+- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter( ModelType.GPT_4)` will be used. (default: :obj:`None`)
+- **timeout** (Optional[float], optional): The timeout value in seconds for API calls. If not provided, will fall back to the MODEL_TIMEOUT environment variable or default to 180 seconds. (default: :obj:`None`)
+- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`) **kwargs (Any): Additional arguments to pass to the client initialization.
+
+<a id="camel.models.amd_model.AMDModel.__init__"></a>
+
+### __init__
+
+```python
+def __init__(
+ self,
+ model_type: Union[ModelType, str],
+ model_config_dict: Optional[Dict[str, Any]] = None,
+ api_key: Optional[str] = None,
+ url: Optional[str] = None,
+ token_counter: Optional[BaseTokenCounter] = None,
+ timeout: Optional[float] = None,
+ max_retries: int = 3,
+ **kwargs: Any
+):
+```
+
+<a id="camel.models.amd_model.AMDModel.check_model_config"></a>
+
+### check_model_config
+
+```python
+def check_model_config(self):
+```
diff --git a/docs/mintlify/reference/camel.types.enums.mdx b/docs/mintlify/reference/camel.types.enums.mdx
index 0641f922f..292a1532a 100644
--- a/docs/mintlify/reference/camel.types.enums.mdx
+++ b/docs/mintlify/reference/camel.types.enums.mdx
@@ -76,6 +76,16 @@ def is_openai(self):
Returns whether this type of models is an OpenAI-released model.
+<a id="camel.types.enums.ModelType.is_amd"></a>
+
+### is_amd
+
+```python
+def is_amd(self):
+```
+
+Returns whether this type of models is a AMD model.
+
<a id="camel.types.enums.ModelType.is_aws_bedrock"></a>
### is_aws_bedrock