Semestrální práce
Všeobecné požadavky
Semestrální práce musí:
- Být vypracována samostatně předkládajícím studentem s řádným uvedením všech zdrojů použitých při její tvorbě.
- Být odevzdaná jako merge request na Gitlabu, kde nejméně jeden váš cvičící je označen jako Assignee do 26. 5. 2024 23:59:59 .
- Využijte prosím větev semestral ve svých repozitářích pro průběžné verzování a ukládání své semestrální práce.
- Obsahovat jednoduchý dokumentační README.md soubor popisující funkci a způsob spuštění/použití aplikace, nezbytné závislosti, postup spuštění testů z CLI. Tento soubor již v repozitářích máte, tak ho jen upravte.
- Obsahovat průvodní zprávu k semestrální práci v <username>.pdf, více viz #Průvodní zpráva. (<username> nahraďte za váš školní username)
- Obsahovat alespoň dvě ze následujících: Numpy, nějaký druh vizualizace (matplotlib, vykreslování hry, GUI…), zpracování CLI parametrů, práce se soubory/DB, requests.
- Splňovat PEP8, detaily viz Codestyle.
- Být testovaná pomocí unit testů (pytest), které fungují a testují významnou část kódu.
K dispozici je několik rámcových i konkrétních zadání. Vlastní zadání je možné po dohodě se cvičícím. Vlastní zadání uvítáme.
S ohledem na množství kreditů (5) za předmět a požadovaný objem práce studenta (25-30 hodin na 1 kredit), si prosím rozplánujte váš čas pro předmět BI-PYT tak, abyste si na semestrální práci rezervovali cca 50-80 hodin. Nenechávejte to na poslední chvíli.
Volba, upřesňování a schvalování zadání semestrálních prací je v gesci cvičících. Je zcela na nich, jaké zvolí metody a určí termíny (např. do kdy musí mít student schváleno zadání), stejně tak, zda a jak budou nedodržení termínů sankcionovat (např.: snížením dosažitelného maxima bodů za SP).
V případě i pouhého podezření, že SP nebyla vypracována studentem osobně má cvičící pravomoc udělit libovolné množství bodů z rozsahu 0 až -40 a věc postoupit k disciplinárnímu řízení.
Pokud něco není jasné, ptejte se včas!
Průvodní zpráva
Report k SP slouží hlavně cvičícím k tomu, aby mohli zhodnotit vaši SP. Měl by být obsažný, výstižný a krátký (stačí 1 str. A4), musí ale obsahovat všechny klíčové části:
- Jaký problém/úkol práce řeší (stačí výstižný odstavec),
- jaké metody/postupy/algoritmy jste použili (buďte konkrétní, pochlubte se netradičním přístupem),
- jakých výsledků jste dosáhli, případně nedosáhli – pak ale taky vysvětlit PROČ; zde je ideální prostor pro graf/screenshot
- zda a jak vaše SP půjde dál použít či rozvíjet,
- konkrétní a přesné reference na zdroje, z nichž jste čerpali (citujte dle ISO690; zvláštní pozornost věnujte citování online zdrojů, aby měly všechny náležitosti; využijte permalinky; citujte i použití generativních AI modelů jako chatGPT – viz: Jak citovat AI?).
Různá tvrzení je vhodné doložit vhodně prezentovanými daty (tabulka, graf, …), odkazem na vědecké články a další literaturu a zdroje, které jste užili. Report pište česky/slovensky, nebo anglicky. Přečtěte si ho po sobě a opravte chyby. ;-) Hodnocení reportu je součástí hodnocení vaší semestrální práce.
TIP: Pokud se nevejdete do dvou, nejvýše 3 stránek dvojsloupcového layoutu vzorových šablon, je něco špatně. Zkuste vypustit evidentní věci, jako je třeba popis schváleného zadaní, obsah readme souboru, uživatelskou nápovědu atd., nepopisujte známé algoritmy – odkažte na zdroj, zvyšte informační hustotu.
Šablona pro LaTeX
- projekt ke zkopírování na OverLeafu (online LaTeX editor) – Jak si udělat kopii projektu?
- pyt-report-template.zip (záloha, když by nefungoval odkaz výše)
Dílčí sekce v šabloně je pochopitelně možno upravit/odebrat/přidat.
Vzorový report od vašich předchůdců
- excelentní report od kolegy Matouše Dlabala (BI-PYT v ZS 2020/2021)
- velmi pěkný report od kolegy Petera Mitury (MI-MVI v ZS 2017/2018)
- další pěkný report od kolegy Filipy Chodury (BI-PYT v ZS 2023/2024)