rg.Settings
¶
rg.Settings
is used to define the settings of an Argilla Dataset
. The settings can be used to configure the
behavior of the dataset, such as the fields, questions, guidelines, metadata, and vectors. The Settings
class is
passed to the Dataset
class and used to create the dataset on the server. Once created, the settings of a dataset
cannot be changed.
Usage Examples¶
Creating a new dataset with settings¶
To create a new dataset with settings, instantiate the Settings
class and pass it to the Dataset
class.
import argilla as rg
settings = rg.Settings(
guidelines="Select the sentiment of the prompt.",
fields=[rg.TextField(name="prompt", use_markdown=True)],
questions=[rg.LabelQuestion(name="sentiment", labels=["positive", "negative"])],
)
dataset = rg.Dataset(name="sentiment_analysis", settings=settings)
# Create the dataset on the server
dataset.create()
To define the settings for fields, questions, metadata, vectors, or distribution, refer to the rg.TextField
, rg.LabelQuestion
, rg.TermsMetadataProperty
, and rg.VectorField
, rg.TaskDistribution
class documentation.
Adding or removing properties to settings¶
The settings object can be modified before create the dataset by adding, replacing or removing properties by using
the method settings.add
and settings.<>.remove
import argilla as rg
settings = rg.Settings(
guidelines="Select the sentiment of the prompt.",
fields=[rg.TextField(name="prompt", use_markdown=True)],
questions=[rg.LabelQuestion(name="sentiment", labels=["positive", "negative"])],
)
# Adding a new property
settings.add(rg.TextField(name="response", use_markdown=True))
# Replace an existing property by other property type
settings.add(rg.TextQuestion(name="response", use_markdown=False))
# Remove an existing property
settings.questions.remove("response")
Creating settings using built in templates¶
Argilla provides built-in templates for creating settings for common dataset types. To use a template, use the class methods of the Settings
class. There are three built-in templates available for classification, ranking, and rating tasks. Template settings also include default guidelines and mappings.
Classification Task¶
You can define a classification task using the rg.Settings.for_classification
class method. This will create a dataset with a text field and a label question. You can select field types using the field_type
parameter with image
or text
.
This will return a Settings
object with the following settings:
settings = Settings(
guidelines="Select a label for the document.",
fields=[rg.TextField(field_type)(name="text")],
questions=[LabelQuestion(name="label", labels=labels)],
mapping={"input": "text", "output": "label", "document": "text"},
)
Ranking Task¶
You can define a ranking task using the rg.Settings.for_ranking
class method. This will create a dataset with a text field and a ranking question.
This will return a Settings
object with the following settings:
settings = Settings(
guidelines="Rank the responses.",
fields=[
rg.TextField(name="instruction"),
rg.TextField(name="response1"),
rg.TextField(name="response2"),
],
questions=[RankingQuestion(name="ranking", values=["response1", "response2"])],
mapping={
"input": "instruction",
"prompt": "instruction",
"chosen": "response1",
"rejected": "response2",
},
)
Rating Task¶
You can define a rating task using the rg.Settings.for_rating
class method. This will create a dataset with a text field and a rating question.
This will return a Settings
object with the following settings:
settings = Settings(
guidelines="Rate the response.",
fields=[
rg.TextField(name="instruction"),
rg.TextField(name="response"),
],
questions=[RatingQuestion(name="rating", values=[1, 2, 3, 4, 5])],
mapping={
"input": "instruction",
"prompt": "instruction",
"output": "response",
"score": "rating",
},
)
Settings
¶
Bases: DefaultSettingsMixin
, Resource
Settings class for Argilla Datasets.
This class is used to define the representation of a Dataset within the UI.
Source code in src/argilla/settings/_resource.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
|
__init__(fields=None, questions=None, vectors=None, metadata=None, guidelines=None, allow_extra_metadata=False, distribution=None, mapping=None, _dataset=None)
¶
Parameters:
Name | Type | Description | Default |
---|---|---|---|
fields |
List[Field]
|
A list of Field objects that represent the fields in the Dataset. |
None
|
questions |
List[Union[LabelQuestion, MultiLabelQuestion, RankingQuestion, TextQuestion, RatingQuestion]]
|
A list of Question objects that represent the questions in the Dataset. |
None
|
vectors |
List[VectorField]
|
A list of VectorField objects that represent the vectors in the Dataset. |
None
|
metadata |
List[MetadataField]
|
A list of MetadataField objects that represent the metadata in the Dataset. |
None
|
guidelines |
str
|
A string containing the guidelines for the Dataset. |
None
|
allow_extra_metadata |
bool
|
A boolean that determines whether or not extra metadata is allowed in the Dataset. Defaults to False. |
False
|
distribution |
TaskDistribution
|
The annotation task distribution configuration. Default to DEFAULT_TASK_DISTRIBUTION |
None
|
mapping |
Dict[str, Union[str, Sequence[str]]]
|
A dictionary that maps incoming data names to Argilla dataset attributes in DatasetRecords. |
None
|
Source code in src/argilla/settings/_resource.py
to_json(path)
¶
Save the settings to a file on disk
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
The path to save the settings to |
required |
Source code in src/argilla/settings/_resource.py
from_json(path)
classmethod
¶
Load the settings from a file on disk
from_hub(repo_id, subset=None, feature_mapping=None, **kwargs)
classmethod
¶
Load the settings from the Hub
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repo_id |
str
|
The ID of the repository to load the settings from on the Hub. |
required |
subset |
Optional[str]
|
The subset of the repository to load the settings from. |
None
|
feature_mapping |
Dict[str, Literal['question', 'field', 'metadata']]
|
A dictionary that maps incoming column names to Argilla attributes. |
None
|
Source code in src/argilla/settings/_resource.py
add(property, override=True)
¶
Add a property to the settings
Parameters:
Name | Type | Description | Default |
---|---|---|---|
property |
Union[Field, VectorField, MetadataType, QuestionType]
|
The property to add |
required |
override |
bool
|
If True, override the existing property with the same name. Otherwise, raise an error. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
Union[Field, VectorField, MetadataType, QuestionType]
|
The added property |