Skip to content

Commit

Permalink
Fix TLMOptions docs formatting (#357)
Browse files Browse the repository at this point in the history
  • Loading branch information
huiwengoh authored Feb 6, 2025
1 parent 6b1ae6d commit b7e65af
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions cleanlab_studio/studio/trustworthy_language_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -790,8 +790,8 @@ class TLMOptions(TypedDict):
You can set custom values for these arguments regardless of the quality preset specified.
Args:
model ({"gpt-4o-mini", "gpt-4o", "o3-mini", "o1", "o1-mini", "o1-preview", "gpt-3.5-turbo-16k", "gpt-4", "claude-3.5-sonnet-v2",
"claude-3.5-sonnet", "claude-3.5-haiku", "claude-3-haiku", "nova-micro", "nova-lite", "nova-pro"}, default = "gpt-4o-mini"):
model ({"gpt-4o-mini", "gpt-4o", "o3-mini", "o1", "o1-mini", "o1-preview", "gpt-3.5-turbo-16k", "gpt-4", "claude-3.5-sonnet-v2", \
"claude-3.5-sonnet", "claude-3.5-haiku", "claude-3-haiku", "nova-micro", "nova-lite", "nova-pro"}, default = "gpt-4o-mini"): \
Underlying base LLM to use (better models yield better results, faster models yield faster/cheaper results).
- Models still in beta: "o1", "o3-mini", "o1-mini", "claude-3.5-sonnet-v2", "claude-3.5-haiku", "nova-micro", "nova-lite", "nova-pro".
- Recommended models for accuracy: "gpt-4o", "o1", "claude-3.5-sonnet-v2".
Expand Down Expand Up @@ -835,8 +835,9 @@ class TLMOptions(TypedDict):
custom_eval_criteria (List[Dict[str, Any]], default = []): optionally specify custom evalution criteria.
The expected input format is a list of dictionaries, where each dictionary has the following keys:
- name: Name of the evaluation criteria.
- criteria: Instructions specifying the evaluation criteria.
Currently, only one custom evaluation criteria at a time is supported.
- criteria: Instructions specifying the evaluation criteria.
Currently, only one custom evaluation criteria at a time is supported.
"""

model: NotRequired[str]
Expand Down

0 comments on commit b7e65af

Please sign in to comment.