> For the complete documentation index, see [llms.txt](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/yaml/editor.md).

# Les paramètres de bases du YAML

Un fichier de configuration de dataset en **yaml** comporte en entête comporte deux paramètres. 

**DatasetName** : variable qui contient le nom du fichier en sortie, les espaces sont supportées et dans cette version du logiciel il n'est pas encore possible de nommer dynamiquement avec une date le fichier directement de le yaml

**numberOfRecords** : variable qui contient le nombre de ligne que le dataset contiendra.

```yaml
datasetName: messageAMF
numberOfRecords: 100
bone: ou fields: 
    ...
```

bones et fields sont deux vairiable très importantes dans la onfiguraiton du dataset (voir la prochaine page), elles permettent de configurer le point d'entré du dataset.

Afin de vous aider à comprendre le fichier voici un exemple de yaml complet et le dataset qu'il génère en suite

{% tabs %}
{% tab title="Yaml" %}

````yaml
datasetName: UserProfiles
numberOfRecords: 410000
fields:
  - fieldName: age
    min: 0
    max: 100
    type: integer

  - fieldName: salaire
    min: 0
    max: 1000
    type: integer
  
  - fieldName: epargne
    min: 0
    max: 300000
    type: integer

  - fieldName: lecteurs
    type: array
    rules: 
      count: 2
    fields:
      - fieldName: Salaire2
        type: integer
        rules:
          range:
            min: 0
            max: 1000
    

  - fieldName: id
    type: id
    rules:
      len: 15
      includeLetters: true
      includeNumbers: true
      includeSpecialChars: false
```
````

{% endtab %}

{% tab title="dataset" %}

<pre class="language-json"><code class="lang-json">// fichier json en sortie
[
    {
        "age": 84,
        "salaire": 34,
        "epargne": 12,
        "lecteurs": [775, 544],
        "id": "Thsaf0iXy4nG6DS"
<strong>    },
</strong>    {
        "age": 18,
        "salaire": 99,
        "epargne": 93,
        "lecteurs": [711, 101],
        "id": "z5PYnpH3ZBf4FYE"
    },
    ...
]
</code></pre>

{% endtab %}
{% endtabs %}