Skip to content

Commit

Permalink
add note about async methods
Browse files Browse the repository at this point in the history
  • Loading branch information
huiwengoh committed Apr 13, 2024
1 parent 6b26c6c commit 2806d47
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions cleanlab_studio/studio/trustworthy_language_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,8 @@ async def prompt_async(
) -> Union[TLMResponse, List[TLMResponse]]:
"""
Asynchronously get response and trustworthiness score for any text input from TLM.
This method is similar to the [`prompt()`](#method-prompt) method but operates asynchronously.
This method is similar to the [`prompt()`](#method-prompt) method but operates asynchronously,
allowing for non-blocking concurrent operations.
Args:
prompt (str | Sequence[str]): prompt (or list of multiple prompts) for the TLM
Expand Down Expand Up @@ -452,7 +453,8 @@ async def get_trustworthiness_score_async(
response: Union[str, Sequence[str]],
) -> Union[float, List[float]]:
"""Asynchronously gets trustworthiness score for prompt-response pairs.
This method is similar to the [`get_trustworthiness_score()`](#method-get_trustworthiness_score) method but operates asynchronously.
This method is similar to the [`get_trustworthiness_score()`](#method-get_trustworthiness_score) method but operates asynchronously,
allowing for non-blocking concurrent operations.
Args:
prompt (str | Sequence[str]): prompt (or list of prompts) for the TLM to evaluate
Expand Down

0 comments on commit 2806d47

Please sign in to comment.