argilla-io / argilla

Argilla is a collaboration tool for AI engineers and domain experts to build high-quality datasets
https://docs.argilla.io
Apache License 2.0
3.91k stars 368 forks source link

[Python client] Add usage example to docstrings in record models #415

Closed dvsrepo closed 3 years ago

dvsrepo commented 3 years ago

Include usage examples for:

Text2Text, TextClassification, TokenClassification records to be shown in the docs here: https://rubrix.readthedocs.io/en/stable/reference/python_client.html#module-rubrix.client.models

You can see how it's done for the methods here for example:

https://github.com/recognai/rubrix/blob/02e6b752ed445acd076dcda7a910cfdb96bc05ba/src/rubrix/__init__.py#L99

The relevant file is src/client/models.py: https://github.com/recognai/rubrix/blob/master/src/rubrix/client/models.py

issam9 commented 3 years ago

I'll work on this

dvsrepo commented 3 years ago

Thanks @issam9 !!