How-to guides¶
These guides provide step-by-step instructions for common scenarios, including detailed explanations and code samples. They are divided into two categories: basic and advanced. The basic guides will help you get started with the core concepts of Argilla, while the advanced guides will help you explore more advanced features.
Basic¶
-
Manage users and credentials
Learn what they are and how to manage (create, read and delete)
Usersin Argilla. -
Manage workspaces
Learn what they are and how to manage (create, read and delete)
Workspacesin Argilla. -
Create, update, and delete datasets
Learn what they are and how to manage (create, read and delete)
Datasetsand customize them using theSettingsforFields,Questions,MetadataandVectors. -
Add, update, and delete records
Learn what they are and how to add, update and delete the values for a
Record, which are made up ofMetadata,Vectors,SuggestionsandResponses. -
Distribute the annotation
Learn how to use Argilla's automatic
TaskDistributionto annotate as a team efficiently. -
Annotate a dataset
Learn how to use the Argilla UI to navigate
Datasetsand submitResponses. -
Query and filter a dataset
Learn how to query and filter a
Dataset. -
Import and export datasets and records
Learn how to export your
Datasetor itsRecordsto Python, your local disk, or the Hugging Face Hub.
Advanced¶
-
Custom fields with layout templates
Learn how to create
CustomFieldswith HTML, CSS and JavaScript templates. -
Use webhooks to respond to server events
Learn how to use Argilla webhooks to receive notifications about events in your Argilla Server.
-
Webhooks internals
Learn how Argilla webhooks are implented under the hood and the structure of the different events.
-
Use Markdown to format rich content
Learn how to use Markdown and HTML in
TextFieldto format chat conversations and allow for basic multi-modal support for images, audio, video and PDFs. -
Migrate to Argilla V2
Learn how to migrate
Users,WorkspacesandDatasetsfrom Argilla V1 to V2.