How-to guides¶
This page is currently under construction. Please check back later for updates.
Deployment and configuration¶
-
Deploy with Docker
Learn how to deploy Extralit using Docker containers for a quick and easy setup.
-
Deploy with Kubernetes
Discover how to deploy Extralit on a Kubernetes cluster for scalable and managed environments.
-
Configure Deployments
Learn how to configure various deployment options and customize Extralit for your specific needs.
-
Upgrade Extralit
Find out how to safely upgrade your Extralit installation to the latest version.
Server management¶
-
Manage users and credentials
Learn what they are and how to manage (create, read and delete)
Users
in Argilla. -
Manage workspaces
Learn what they are and how to manage (create, read and delete)
Workspaces
in Argilla. -
Create, update, and delete datasets
Learn what they are and how to manage (create, read and delete)
Datasets
and customize them using theSettings
forFields
,Questions
,Metadata
andVectors
. -
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
,Suggestions
andResponses
. -
Distribute the annotation
Learn how to use Argilla's automatic
TaskDistribution
to annotate as a team efficiently. -
Annotate a dataset
Learn how to use the Argilla UI to navigate
Datasets
and 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
Dataset
or itsRecords
to Python, your local disk, or the Hugging Face Hub.
Advanced guides¶
-
Custom fields with layout templates
Learn how to create
CustomFields
with 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
TextField
to 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
,Workspaces
andDatasets
from Argilla V1 to V2.