Add docs/LIEPA-3-README.md

docs/LIEPA-3-README.md

@@ -0,0 +1,421 @@
+# DIDYSIS LIETUVIŲ KALBOS GARSYNAS (LIEPA-3)
+
+## Turinys
+
+1. [Garsynas](#garsynas)
+2. [Duomenys apie garsyną](#duomenys-apie-garsyną)
+3. [Statistika](#statistika)
+4. [Failai ir katalogai](#failai-ir-katalogai)
+ 
+   * [Žymėjimo kodai](#žymėjimo-kodai)
+   * [Garsyno katalogų struktūra](#garsyno-katalogų-struktūra)
+   * [Dialektų (dial) dalis](#dialektų-dial-dalis)
+   * [Fonetinė (phon) dalis](#fonetinė-phon-dalis)
+     * [Fonetinių anotacijų failai](#fonetinių-anotacijų-failai)
+
+   * [Skaitytinė (read) dalis](#skaitytinė-read-dalis)
+   * [Spontaninė (spon) dalis](#spontaninė-spon-dalis)
+   * [Metaduomenų failai](#metaduomenų-failai)
+     * [metadadata-dial.csv](#metadadata-dialcsv)
+     * [metadadata-phon.csv](#metadadata-phoncsv)
+
+6. [Garsyno autoriai ir licencija](#garsyno-autoriai-ir-licencija)
+
+
+
+## Garsynas
+
+Didysis lietuvių kalbos garsynas (LIEPA-3) – atviras kalbos duomenų rinkinys,
+skirtas šnekos atpažinimo tikslams ir moksliniams tyrimams.
+
+Pagrindiniai panaudojimo būdai:
+
+* lietuvių šnekos atpažinimo sistemos, jų apmokymas;
+* DNT/DI sistemų/modelių apmokymas ir derinimas atpažinti lietuvių kalbos
+šneką;
+* moksliniai tyrimai.
+
+Garsyną sudaro 4 dalys:
+
+* dialektų garsynas (**dial**): 100 val.
+* fonetiškai anotuota (**phon**): 500[^1] val.
+* skaitytinė kalba (**read**): 5000 val.
+* spontaninė kalba (**spon**): 4900 val.
+
+[^1]: papildomai fonetiškai anotuota spon garsyno dalis
+
+
+## Duomenys apie garsyną
+
+| Parametras      | Reikšmė                                                   |
+|-----------------|-----------------------------------------------------------|
+| Kalba           | Lietuvių                                                  |
+| Kalbos tipas    | Skaitoma, spontaninė, dialektas ir kt.                    |
+| Garsyno apimtis | 10 000 val.                                               |
+| Garso formatas  | FLAC                                                      |
+| Įrašų kokybė    | 44,1 kHz, 16 bitų, mono                                   |
+| Įrašymo sąlygos | Įvairios                                                  |
+| Anotavimo lygiai| Frazių (10 000 val.); žodžių, skiemenų, fonemų (500 val.) |
+| Frazių skaičius | ~7 mln. (read + spon)                                     |
+| Žodžių skaičius | ~70 mln. (read + spon)                                    |
+| Failų skaičius  | ~7,5 mln.                                                 |
+| Bendras dydis   | ~1,27 TB                                                  |
+
+
+
+## Statistika
+
+|    Garsyno dalis    | Trukmė h:m:s | Kalbėtojų |   Frazių  |   Žodžių  |   Failų   | Dydis |
+|--------------------:|-------------:|----------:|----------:|----------:|----------:|------:| 
+|  Dialektų (**dial**)|    100:29:24 |       117 |   111 970 |   916 343 |   111 970 | 15 GB |
+|  Fonetinė (**phon**)|501:08:59[^1] |   500[^2] | 1 084 228 | 4 383 938 |   145 644 | 74 GB |
+|Skaitytinė (**read**)|   5015:37:12 |      7125 | 2 699 385 |26 984 811 | 2 699 385 |578 GB |
+|Spontaninė (**spon**)|   4937:25:27 |  5000[^2] | 4 527 544 |43 135 179 | 4 527 544 |608 GB |
+
+[^1]: papildomai fonetiškai anotuota spon garsyno dalis
+[^2]: minimalus įvertis, žemutinė riba (neįmanoma tiksliai nustatyti) 
+
+
+Pasiskirstymas pagal lytį:
+
+|    Garsyno dalis    | Viso, val. | Vyr., val. (%) |  Mot., val. (%) |
+|--------------------:|-----------:|---------------:|----------------:|
+|  Dialektų (**dial**)|        100 |      23 (23 %) |       77 (77 %) |
+|  Fonetinė (**phon**)|        501 |     291 (58 %) |      210 (42 %) |
+|Skaitytinė (**read**)|      5 015 |   2 154 (43 %) |    2 842 (57 %) |  
+|Spontaninė (**spon**)|      4 937 |   2 552 (52 %) |    2 385 (48 %) | 
+
+
+
+Frazių/įrašų trukmės:
+
+|    Garsyno dalis    | Min, s | Avg, s | Max, s |
+|--------------------:|:------:|:------:|:------:|
+|  Dialektų (**dial**)|  0,70  |  3,23  |  29,98 |
+|  Fonetinė (**phon**)|    -   |    -   |    -   | 
+|Skaitytinė (**read**)|  1,08  |  6,69  |  38,76 |
+|Spontaninė (**spon**)|  0,80  |  3,93  |  30,00 |
+
+
+## Failai ir katalogai
+
+### Žymėjimo kodai
+
+*Regionas*:
+- **A**: Aukštaitija
+- **D**: Dzūkija
+- **S**: Suvalkija
+- **Z**: Žemaitija
+
+*Apskritis*:
+- **AL**: Alytaus
+- **KA**: Kauno
+- **KL**: Klaipėdos
+- **KT**: Kita
+- **MA**: Marijampolės
+- **PA**: Panevėžio
+- **SI**: Šiaulių
+- **TA**: Tauragės
+- **TE**: Telšių
+- **UT**: Utenos
+- **VI**: Vilniaus
+
+*Įrašo kalbos tipas*:
+- **M**: mišri (Mixed)
+- **R**: skaitytinė (Read)
+- **S**: spontaninė (Spontaneous)
+
+*Įrašo šaltinio tipas*:
+
+- **A**: audio knygos (Audio Books)
+- **D**: diktofoniniai įrašai (Dictaphone)
+- **P**: telefoninė šneka (Phone)
+- **R**: radijo įrašai (Radio)
+- **S**: studijos įrašai (Studio)
+- **T**: televizijos įrašai (TV)
+- **U**: nenustatyta/nežinoma (Unknown/Unspecified)
+
+*Lytis*:
+- **F**: moteris (Female)
+- **M**: vyras (Male)
+
+*Amžiaus grupė*:
+- **1**: iki 12 m.
+- **2**: 13–17 m.
+- **3**: 18–60 m.
+- **4**: virš 60 m.
+
+### Garsyno katalogų struktūra
+
+Garsyno failai paskirstyti į katalogus pagal garsyno tipą/dalį tokioje
+katalogų struktūroje.
+
+```
+Garsynas/  – Pagrindinis garsyno katalogas
+  │
+  ├── audio/ – Garso įrašų failai
+  │    ├── dial/     
+  │    ├── phon/    
+  │    ├── read/    
+  │    └── spon/    
+  │
+  ├── etc/  – Kiti garsyno failai (aprašai, anotacijos, kt. dokumentai)
+  │    ├── dial/     
+  │    ├── phon/    
+  │    ├── read/    
+  │    └── spon/    
+  │
+  └── README.md
+```
+
+---
+
+### Dialektų (dial) dalis
+
+Dialektų garsyno įrašų failai yra paskirstyti į katalogus pagal:
+
+* *regioną*: ( A/ | D/ | S/ | Z/) ;
+* *lytį ir amžiaus grupę* ( F1/ | F2/ | F3/ | F4/ | M1/ | M2/ | M3/ | M4/ );
+* *diktoriaus įrašų sesiją*.
+
+Diktorių įrašų sesijos katalogai yra tokio formato:
+
+`{R}{ID}{SN}-{meta}`
+
+Įrašų failų pavadinimai yra tokio formato:
+
+`{R}{ID}{SN}-{meta}-{0123}.flac`
+
+{**R**} – Regionas;
+
+{**ID**} – dviejų skaitmenų diktoriaus numeris
+({R}+{ID} sudaro unikalų diktoriaus kodą);
+
+{**SN**} – dviejų skaitmenų įrašų sesijos numeris (01, 02, 03, ...), jei
+diktorius įkalbėjo ne vieną įrašą;
+
+{**meta**} – keturių simbolių meta informacijos kodas (kalbos tipas, šaltinis,
+lytis, amžiaus grupė); pirmieji du meta informacijos lauko simboliai dialektų
+garsynui visada yra **SD**, kas reiškia spontaninę kalba, diktofoninius įrašus.
+
+{**0123**} – keturių skaitmenų frazės/įrašo eilės numeris.
+
+Pavyzdžiui: `audio/dial/A/F3/A0401-SDF3/A0401-SDF3-0001.flac`
+
+Diktoriaus sesijos katalogas **A0401-SDF3** (`{A}{04}{01}-{SDF3}`): **A**
+Aukštaitijos regionas, diktoriaus numeris **04** (unikalus diktoriaus kodas
+**A04**), įrašo sesijos numeris **01**, įrašo meta informacija **SDF3**
+(spontaninė kalba, diktofonas, moteris, trečia amžiaus grupė)
+
+---
+
+### Fonetinė (phon) dalis
+
+Fonetinės garsyno dalies įrašų failai yra paskirstyti į katalogus pagal:
+
+* *kalbos tipą* ( M/ | R/ | S/ );
+* *šaltinį* ( A/ | D/ | P/ | R/ | S/ | T/ | U/ );
+* *lytį ir amžiaus grupę* ( F1/ | F2/ | F3/ | F4/ | M1/ | M2/ | M3/ | M4/ );
+* *dar vieną indeksinį katalogą*.
+
+Dar vienas gilesnis/indeksinis katalogas reikalingas paskirstyti didelį failų
+kiekį; šio katalogo pavadinimas prasmės neturi ir yra pavadintas pagal įrašo
+failo sha1 maišos kodo pirmojo baito reikšmę.
+
+Įrašų failų pavadinimai yra tokio formato:
+
+`{hash}-{meta}.flac`
+
+{**hash**} – unikalus 12 simbolių kodas (įrašo failo sha1 maišos kodo pirmieji
+6 baitai)
+
+{**meta**} – 4 simbolių meta informacijos kodas (kalbos tipas, šaltinis, lytis,
+amžiaus grupė)
+
+Pavyzdžiui: `audio/phon/M/T/M3/0a/0aa3e7f0cc33-MTM3.flac`
+
+```
+$ sha1sum 0aa3e7f0cc33-MTM3.flac
+0aa3e7f0cc339cc8f9325d4649345e96c4257599  0aa3e7f0cc33-MTM3.flac
+```
+
+`MTM3`:
+kalbos tipas: **M** – mišri, šaltinis: **T** – televizijos įrašas,
+lytis ir amžiaus grupė: **M3** – vyras, trečios amžiaus grupės (18-60 m.)
+
+#### Fonetinių anotacijų failai
+
+Fonetinės (phon) garsyno dalies anotacijų failai – TextGrid (Praat) formato,
+UTF-8 koduotės.
+Šiuose failuose, takeliuose (*angl.: IntervalTier*), yra įvairios frazių
+anotacijos:
+
+1. **phones** – fonemų anotacija;
+2. **syll** – skiemenų anotacija;
+3. **words** – žodžių anotacija;
+4. **phono** – fonetinė transkripcija;
+5. **ortho** – tekstinė transkripcija.
+
+Anotavimas fonemomis grįstas aibe, sukurta lietuvių kalbos sintezei, kurią
+sudaro 92 vienetai: 34 balsiai, 57 priebalsiai ir pauzė. Išsamus fonemų
+aibės/rinkinio aprašymas: [P. Kasparaitis, Diphone databases for Lithuanian
+text-to-speech synthesis. Informatica, 16(2), 2005, p. 193–202.](https://informatica.vu.lt/journal/INFORMATICA/article/1037/info)
+
+---
+
+### Skaitytinė (read) dalis
+
+Skaitytinės garsyno dalies failai yra paskirstyti į katalogus pagal:
+
+* *apskritį* ( AL/ | KA/ | KL/ | KT/ | MA/ | PA/ | SI/ | TA/ | TE/ | UT/ | VI/ );
+* *diktoriaus kodą*.
+
+Diktorių kodai/katalogai: `{D12345}` – 6 simbolių diktoriaus kodas.
+
+Įrašų failų pavadinimų formatas:
+
+`{0123}.flac` {**0123**} – 4 skaitmenų failo eilės numeris.
+
+Pavyzdžiui: `audio/read/AL/A07684/0491.flac`
+
+**AL** Alytaus apskritis, **A07684** diktoriaus kodas.
+
+---
+
+### Spontaninė (spon) dalis
+
+Spontatinės garsyno įrašų dalies failai yra paskirstyti į katalogus pagal:
+
+* *kalbos tipą* ( M/ | R/ | S/ );
+* *šaltinį* ( A/ | D/ | P/ | R/ | S/ | T/ | U/ );
+* *lytį ir amžiaus grupę* ( F1/ | F2/ | F3/ | F4/ | M1/ | M2/ | M3/ | M4/ );
+* *dar du gilesnius indeksinius katalogus*.
+
+Papildomas, dviejų katalogų lygio, indeksinis skirstymas reikalingas
+paskirstyti didelį failų kiekį; šių indeksinių katalogų pavadinimai prasmės
+neturi ir yra pavadinti pagal įrašo failo sha1 maišos kodo pirmųjų 2 baitų
+reikšmes.
+
+Įrašų failų pavadinimai yra tokio formato:
+
+`{hash}-{meta}.flac`
+
+{**hash**} – unikalus 12 simbolių kodas (įrašo failo sha1 maišos kodo pirmieji
+6 baitai)
+
+{**meta**} – 4 simbolių meta informacijos kodas (kalbos tipas, šaltinis, lytis,
+amžiaus grupė)
+
+Pavyzdžiui: `audio/spon/S/R/F3/d2/1a/d21ae38e252b-SRF3.flac`
+
+```
+$ sha1sum d21ae38e252b-SRF3.flac
+d21ae38e252b3d50f7d75c55d70f744aa0c1b827  d21ae38e252b-SRF3.flac
+```
+
+`SRF3`:
+kalbos tipas: **S** – spontaninė, šaltinis: **R** – radijo įrašas,
+lytis ir amžiaus grupė: **F3** – moteris, 3 amžiaus grupės (18-60 m.)
+
+---
+
+### Metaduomenų failai
+
+Metaduomenų failo (`metadata.csv`) formatas – paprastas, UTF-8 koduotės
+tekstinis failas, po įrašą eilutėje, kur '|' simboliu atskirti laukai:
+
+`{įrašo failo kelias}|{įrašo frazės tekstas}`
+
+Pavyzdys:
+
+```
+<...>
+audio/read/AL/B28032/0168.flac|o ką galime pasakyti apie lietuvių tarmių evoliuciją
+audio/read/AL/S50067/0229.flac|su laiku susipažinau su lietuviška veikla europoje ir kitur
+<...>
+audio/spon/S/R/F3/d2/1a/d21ae38e252b-SRF3.flac|o šnekos atpažintuvas dar viena dabar bandoma technologija kai
+audio/spon/S/S/F3/72/e0/72e050b14491-SSF3.flac|tai yra šnekos sintezė ir šnekos atpažinimas
+<...>
+```
+
+Frazių tekstai – normalizuoti, sudaryti tik iš mažųjų raidžių, be skyrybos ir kt. simbolių.
+
+Skirtingų garsyno dalių failų ir katalogų struktūra – skirtinga, tačiau
+taikant paprastą aprašą (įrašo kelias ir įrašo frazės tekstas)
+skaitytinės (**read**) ir spontaninės (**spon**) garsyno dalys apjungtos į
+vieną bendrą `metadata.csv`, kuris visas gali būti panaudotas apmokymui
+(suderinami, tapatūs duomenys).
+
+
+
+Dialektų (**dial**) ir fonetinė (**phon**) garsyno dalys yra specifinės
+(skiriasi anotacijų žymėjimas ir jų tipas/formatas), todėl į bendrą rinkinį
+neįtrauktos ir turi savo atskiruosius aprašus:
+
+* `etc/dial/metadata-dial.csv`
+* `etc/phon/metadata-phon.csv`
+
+#### metadadata-dial.csv
+
+`metadata-dial.csv` failas yra tokio pačio formato, kaip `metadata.csv`, tačiau
+skiriasi anotacijų/transkripcijų užrašymo būdas, naudojami papildomi fonetiniai
+vienetai:
+
+Balsiai:
+
+* e:
+
+  * **æ** – priešakinis nelūpinis balsis, artimas atvirajam (visų patarmių atvirasis e)
+  * **ə** – vidurinis vidutinis nelūpinis balsis (panevėžiškių įterptinis balsis)
+  * **ɜ** – vidurinis vidutinis atviresnysis nelūpinis balsis (suužpakalėjęs e)
+  * **ē** – ilgasis e, žemaičių šnektose suvienbalsintas iš ei
+* ė:
+
+  * **ɘ** – vidurinis vidutinis uždaresnysis nelūpinis balsis balsis (suužpakalėjęs ė)
+* i:
+
+  * **ɨ** – vidurinis uždarasis nelūpinis balsis (suužpakalėję i, y, į)
+* a:
+
+  * **ā** – ilgasis a, žemaičių šnektose suvienbalsintas iš ai
+
+Minkštumas (žymimas tik žodžio gale ir kitais būtinais nemotyvuoto minkštumo atvejais):
+
+* **'** – žymima dešinėje raidės pusėje viršuje
+
+Kirtis:
+
+* pagrindinis kirtis
+
+  * **ˈ** – žymima prieš kirčiuotą skiemenį (skiemens riba nustatoma vadovaujantis STR taisykle)
+* šalutinis kirtis
+
+  * **ˌ** – žymima prieš kirčiuotą skiemenį (skiemens riba nustatoma vadovaujantis STR taisykle)
+
+#### metadadata-phon.csv
+
+`metadata-phon.csv` aprašas yra tokio formato:
+
+```
+{TextGrid failo kelias}|{įrašo failo kelias}|{įrašo frazių tekstai}
+```
+
+Trečiame lauke, `{įrašo frazių tekstai}` – paprastesnei paieškai/atrankai visos įrašo frazės (kabutėse, atskirtos ", "):
+
+`"pirma frazė", "antra frazė", "trečia frazė"...`
+
+Pavyzdys:
+
+```
+etc/phon/grids/M/R/F3/03/035c8ee9ab35-MRF3.TextGrid|audio/phon/M/R/F3/03/035c8ee9ab35-MRF3.flac|"gali jas rasti lrt mediatekoje spotifai platformoje", "o nuotraukos laidos feisbuko paskyroje"
+```
+
+
+
+## Garsyno autoriai ir licencija
+
+* Garsynas sukurtas 2025 – 2026 m. [Vytauto Didžiojo universitete](https://www.vdu.lt),
+[Vilniaus universitete](https://www.vu.lt), [Lietuvių kalbos institute](https://lki.lt)
+* Garsyno licencija: Creative Commons Priskyrimo 4.0 tarptautinė licencija
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.lt)
+