diff --git a/docs/pages/concepts/evaluation_dimension.md b/docs/pages/concepts/evaluation_dimension.md index 657e481c..e3e02d29 100644 --- a/docs/pages/concepts/evaluation_dimension.md +++ b/docs/pages/concepts/evaluation_dimension.md @@ -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: diff --git a/sotopia/database/evaluation_dimensions.py b/sotopia/database/evaluation_dimensions.py index c7f8570c..97ed931e 100644 --- a/sotopia/database/evaluation_dimensions.py +++ b/sotopia/database/evaluation_dimensions.py @@ -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