Skip to content

Commit

Permalink
Update documentation for SotopiaDimension and EvaluationDimensionBuilder
Browse files Browse the repository at this point in the history
  • Loading branch information
openhands-agent committed Dec 8, 2024
1 parent e222ba0 commit c43814a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/pages/concepts/evaluation_dimension.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ The [`EvaluationDimensionBuilder`](/python_API/database/evaluation_dimensions) i
### Initialize the database
The default evaluation metric is still `SotopiaDimensions` in `sotopia.env.evaluators`.There is no `CustomEvaluationDimension` in the database by default. To initialize the database, please refer to `examples/use_custom_dimensions.py`.

### Use the SotopiaDimension
The `SotopiaDimension` can be used directly without initializing the database. It provides a set of predefined evaluation dimensions that are ready to use for evaluating social interactions.

### Use the custom evaluation dimensions
After you initialize your customized evaluation dimensions, you can choose to use any one of these methods provided below:

Expand Down
4 changes: 4 additions & 0 deletions sotopia/database/evaluation_dimensions.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ class CustomEvaluationDimensionList(JsonModel):


class EvaluationDimensionBuilder:
'''
EvaluationDimensionBuilder is a utility class for creating and managing evaluation dimensions.
It provides methods to build evaluation dimension models from various inputs such as primary keys, dictionaries, and names.
'''
@staticmethod
def create_range_validator(
low: int, high: int
Expand Down

0 comments on commit c43814a

Please sign in to comment.