Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs for flatten #5147

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading