VSinerva/markov-music-generator
Archived
1
0
Fork 0
Code Activity

Viikon dokumentaatio

Browse source
This commit is contained in:
Vili Sinervä 2022-09-24 11:05:39 +03:00
parent d056f42b55
commit 59d01d11c8
4 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -3,7 +3,11 @@
## Dokumentaatio
[Määrittelydokumentti](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/maarittelydokumentti.md)
[Testausdokumentti](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/testausdokumentti.md)
### Viikkoraportit
[Viikko 1](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/viikko1.md)
[Viikko 2](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/viikko2.md)
[Viikko 3](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/viikko3.md)

BIN
dokumentaatio/kattavuus.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 47 KiB

17
dokumentaatio/testausdokumentti.md Normal file
View file

@ -0,0 +1,17 @@
# Testausdokumentti
## Testien toteutus
Automaattinen yksikkötestaus on toteutettu pytest-kirjastolla ja testikattavuuden raportoinnin hoitaa coverage-kirjasto.
## Ohjeet
Ennen testien suorittamista tulee pytest- ja coverage-kirjastot olla asennettuna käytössä olevassa ympäristössä. Testit saa suoritettua kommennolla
`pytest src`
projektin juurikansiosta. Testikattavuusraportin voi luoda juurikansiosta komennolla
` coverage run --branch -m pytest src && coverage html`
Tämän jälkeen raportti löytyy tiedostosta `htmlcov/index.html`.
![Testikattavuusraportti. Kokonaiskattavuus 99%](https://github.com/ArcticCoder/markov-music-generator/blob/master/kattavuus.png?raw=true)

9
dokumentaatio/viikko3.md Normal file
View file

@ -0,0 +1,9 @@
# Viikkoraportti 3
Toteutin tällä viikolla varsinaisen Markovin ketjun omaa trie-tietorakennettani hyödyntäen. Varmistin ensin manuaalisesti, että toeutukseni vaikuttaa toimivalta. Tämän jälkeen kirjoitin yksikkötestauksen käyttäen pohjana omia aiempia testejäni.
Opin uutta Markovin ketjuista, sekä pythonin tarjoamista ominaisuuksista.
Minulla oli jälleen melko rajallisesti aikaa käytettävissä, mutta olen tyytyväinen ohjelmani etenemiseen tähän asti. Ensi viikolla toteutan varsinaisen musiikkidatan lukemisen ja melodian generoimisen. Osana tätä toteutan myös käyttöliittymän, joka tulee olemaan ohjaajan ehdotuksesta komentorivivalikko. Tavoitteena on, että ensi viikon jälkeen minulla on toteutettavana enää rytmin generoiminen yhdellä tai useammalla tavalla, sekä muut mahdolliset lopputulosta parantavat hienosäädöt ja erinnäiset säätöparametrit. Uskon vahvasti aikani riittävän tähän tavoitteeseen.
Aikaa käytin tällä viikolla noin 5h.