Skip to content

Commit

Permalink
docs: update docs for flatten (#5147)
Browse files Browse the repository at this point in the history
This PR updates the docs of the flatten param in the `to_list` method.

Co-authored-by: Ben Burtenshaw <[email protected]>
  • Loading branch information
burtenshaw and burtenshaw authored Jul 3, 2024
1 parent d030550 commit fb7b4bd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions argilla/src/argilla/records/_dataset_records.py
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,9 @@ def to_list(self, flatten: bool = False) -> List[Dict[str, Any]]:
Return the records as a list of dictionaries. This is a convenient shortcut for dataset.records(...).to_list().
Parameters:
flatten (bool): Whether to flatten the dictionary and use dot notation for nested keys like suggestions and responses.
flatten (bool): The structure of the exported dictionaries in the list.
- True: The record keys are flattened and a dot notation is used to record attributes and their attributes . For example, `label.suggestion` and `label.response`. Records responses are spread across multiple columns for values and users.
- False: The record fields, metadata, suggestions and responses will be nested dictionary with keys for record attributes.
Returns:
A list of dictionaries of records.
"""
Expand Down

0 comments on commit fb7b4bd

Please sign in to comment.