Podręcznik uczestnika z objaśnieniami, przykładami i ćwiczeniami do samodzielnej nauki
7. Finalizacja, prezentacja i ocena projektu
Projekt jest gotowy do przekazania wtedy, gdy działa, ma spójne dowody i daje się zrozumieć bez obecności autora. Notebook stanowi główny raport obliczeniowy. Wersja HTML lub PDF ułatwia czytanie, a krótka prezentacja prowadzi odbiorcę przez główny przekaz. Żadna z tych form nie powinna zawierać innej wersji faktów.
Uzgodnione nazwy i role
|
Plik lub folder |
Rola w projekcie |
|---|---|
|
notebooks/M6_raport_redakcja.ipynb |
Kopia do porządkowania; nie zastępuje wersji finalnej. |
|
notebooks/M6_raport_finalny.ipynb |
Zatwierdzony raport z kodem i aktualnymi wynikami. |
|
data/processed/pomiary_clean.csv |
Przygotowane wejście do analizy M6. |
|
outputs/tables oraz outputs/figures |
Tabele i wykresy użyte w raporcie. |
|
outputs/M6_raport_finalny.html |
Wersja do czytania; ewentualny PDF ma ten sam rdzeń nazwy. |
|
outputs/M6_prezentacja_wynikow.pptx |
Proponowana nazwa własnej prezentacji uczestnika. |
|
docs/M6_audyt_projektu.md |
Proponowany zapis testów, dowodów i samooceny. |
|
docs/rejestr_uzycia_LLM.csv |
Wspólny rejestr faktycznego użycia modelu. |
|
README.md |
Mapa projektu i instrukcja odtworzenia. |
W materiałach roboczych możesz spotkać wariant M6_raport_eksploatacja.ipynb. W tym podręczniku i karcie pracy stosujemy M6_raport_finalny.ipynb. Nie utrzymuj dwóch konkurencyjnych nazw w instrukcjach. Analogicznie używaj outputs konsekwentnie w kodzie, dokumentacji i poleceniu eksportu.
M6-v2.pptx to prezentacja dydaktyczna kursu, nie nazwa prezentacji, którą tworzysz jako uczestnik. Nowych nazw wyników nie traktuj jako plików, które powinny już być w pakiecie startowym. Powstają w trakcie pracy. Zachowaj istniejące identyfikatory wykresów M4 w odwołaniach do wcześniejszych analiz, nawet jeśli w raporcie nadajesz im kolejne numery rysunków.
README: instrukcja dla osoby, która zaczyna od zera
README nie jest spisem nazw bez wyjaśnienia. Ma pozwolić nowemu odbiorcy ustalić, co otrzymał i jak odtworzyć wynik. Sprawdź je na świeżej kopii pakietu: jeśli musisz coś dopowiedzieć ustnie, tę informację prawdopodobnie warto dopisać.
|
Część README |
Minimalna użyteczna treść |
|---|---|
|
Cel i pytanie |
Problem raportu, odbiorca i granice zakresu. |
|
Zawartość |
Role notebooków, danych, tabel, wykresów i dokumentacji. |
|
Dane |
Pochodzenie, przygotowanie w M2, wersja i rzeczywisty SHA-256. |
|
Środowisko |
Wersja Pythona, używane biblioteki i sposób przygotowania środowiska. |
|
Uruchomienie |
Kolejność etapów i założenie katalogu roboczego kernela. |
|
Wyniki |
Nazwy rezultatów oraz informacja, że ponowny zapis może je zastąpić. |
|
Użycie LLM |
Lokalizacja rejestru i szczegółowych dowodów weryfikacji. |
|
Ograniczenia |
Najważniejsze granice analizy i zakres wykonanego testu odtwarzalności. |
Opis środowiska powinien przedstawiać wersje faktycznie sprawdzone w projekcie. Nie kopiuj bezrefleksyjnie listy wszystkich pakietów z prywatnego komputera. Zbyt szeroka lista utrudnia odtworzenie, a zbyt krótka pomija zależności. Zapisz co najmniej Python, Pandas i Matplotlib oraz narzędzia potrzebne do uruchamiania i eksportu notebooka.
Dwa zakresy odtwarzania
Odtworzenie M6 od pliku processed oznacza, że z przygotowanych danych uzyskujesz ponownie tabele, wykresy i wyniki raportu. Pełne odtworzenie projektu od raw obejmuje dodatkowo przygotowanie danych w M2, jego kontrole i eksport. W README wyraźnie wskaż, który wariant sprawdzono i jaka jest kolejność notebooków.
Przeniesienie kopii do nowego folderu sprawdza przenośność ścieżek, ale nie niezależność od zainstalowanego środowiska. Osobny test w świeżym środowisku sprawdza deklarowane zależności. Jeśli go nie wykonano, nie deklaruj pełnego potwierdzenia. Dokładny opis zakresu testu jest bardziej wartościowy niż ogólne „działa na każdym komputerze”.
W dzienniku audytu zapisz datę, środowisko, wejściowy plik, wykonane kroki i rezultat. Przy niepowodzeniu wskaż pierwszą przyczynę, poprawkę oraz wynik powtórnego testu. Sam znacznik „gotowe” nie pozwala odróżnić wykonanej kontroli od zamiaru.
Eksport i kontrola wersji do czytania
Najpierw uruchom cały notebook po restarcie i zapisz aktualne wyniki. Następnie z terminala otwartego w katalogu głównym projektu wykonaj poniższe polecenie. Wymaga ono dostępnego narzędzia nbconvert; instalacja środowiska jest opisana w materiałach kursu.
jupyter nbconvert --to html notebooks/M6_raport_finalny.ipynb --output-dir outputs
Powstanie outputs/M6_raport_finalny.html. Polecenie bez opcji --execute przekształca zapisany notebook, ale nie uruchamia ponownie komórek. Udany eksport nie jest więc dowodem poprawnego wykonania kodu. Jeśli zapisane wyniki są stare, otrzymasz estetyczny plik ze starymi wynikami.
Otwórz HTML poza Jupyterem. Sprawdź polskie znaki, nagłówki, tabele, kod, etykiety osi i odwołania. Wypróbuj go również bez dostępu do sieci. Obrazy zapisane w wynikach komórek zwykle dają się przenieść z eksportem, lecz zewnętrzne odnośniki, zasoby lub elementy renderowania mogą wymagać połączenia. Samo rozszerzenie HTML nie gwarantuje samowystarczalności.
PDF jest przydatny, gdy potrzebujesz stałego układu stron. Sposób jego przygotowania zależy od dostępnych narzędzi; niezależnie od metody obejrzyj każdą stronę, zwłaszcza szerokie tabele i bloki kodu. Ostateczny format oddania sprawdź w zadaniu w Moodle. Wersja do czytania nie zastępuje notebooka, gdy wymagane jest sprawdzenie obliczeń.
Test przekazania projektu
- Skopiuj komplet pakietu do nowej lokalizacji i postępuj wyłącznie według README.
- Sprawdź dostępność wejść oraz zgodność ścieżek; nie sięgaj do plików poza kopią.
- Uruchom raport po restarcie kernela i ponownie wygeneruj wyniki.
- Porównaj trzy główne ustalenia z tabelami, wykresami i streszczeniem.
- Otwórz eksport i sprawdź, czy zachowuje treść i czytelność bez Jupytera.
Jeśli którykolwiek etap wymaga ręcznego dopisania ścieżki, skopiowania brakującego wykresu lub uruchomienia „zapomnianej” komórki, popraw projekt i instrukcję. Powtórz test od początku. Celem nie jest jednorazowe doprowadzenie pliku do działania, lecz przekazanie procedury możliwej do powtórzenia.
Prezentacja: skrót rozumowania, nie drugi raport
Prezentacja ma ułatwić odbiorcy zapamiętanie głównego ustalenia. Nie powinna powielać wszystkich komórek notebooka. Dla projektu kursowego przydatny jest układ pięciu slajdów, w którym każde ogniwo odpowiada na jedno pytanie.
|
Etap |
Treść slajdu |
|---|---|
|
1. Problem i odbiorca |
Jakie pytanie rozwiązujesz i dlaczego jest ważne? |
|
2. Dane i zakres |
Osiem urządzeń, 720 rekordów, 45 dni; podstawowe ograniczenia. |
|
3. Główny wynik |
Jeden czytelny wykres z miarą, jednostką i liczebnością. |
|
4. Znaczenie i granica |
Co pokazuje wynik, jakie są alternatywne wyjaśnienia i czego nie dowodzi? |
|
5. Wniosek i dalszy krok |
Odpowiedź na pytanie oraz jedna uzasadniona propozycja weryfikacji. |
Wybór jednego wykresu do prezentacji nie oznacza usunięcia pozostałych dowodów z raportu. Możesz odwołać się do nich ustnie lub w krótkim zdaniu, ale slajd nie powinien wymagać równoczesnego odczytywania trzech drobnych wykresów. Najpierw ustal przekaz, potem wybierz ilustrację.
Jeżeli pokazujesz ranking drgań, tytuł „U-05 ma najwyższą medianę drgań w badanym okresie” jest precyzyjniejszy niż „Wyniki”. Dopisz jednak ograniczenie: to nie ranking sprawności. Odbiorca, który zobaczy tylko ten slajd, nie powinien otrzymać innej interpretacji niż czytelnik raportu.
Spójność trzech wersji
Porównaj notebook, eksport i prezentację. Czy wszystkie podają U-05 = 1,374 mm/s, ten sam zakres dat i właściwe n? Czy w jednym miejscu nadal nie pozostała stara etykieta U-08 = 1,360? Czy skracając opis, nie zgubiono informacji o niepełnym lutym albo analizie wrażliwości korelacji?
Zrób próbę opowiedzenia wyniku bez czytania kodu. W dwóch minutach wyjaśnij pytanie, dowód, znaczenie i ograniczenie. Jeżeli musisz długo tłumaczyć, jak interpretować oś, popraw wykres. Jeżeli zakończenie nie odpowiada pytaniu ze slajdu pierwszego, wróć do planu raportu.
Nie deklaruj w prezentacji wykonania dodatkowych analiz tylko dlatego, że brzmią profesjonalnie. Propozycja dalszej kontroli jest wartościowa również wtedy, gdy jasno zaznaczysz, że pozostaje do wykonania.
Samoocena oparta na dowodach
Przed oddaniem projektu oceń nie tylko wygląd, ale cały łańcuch pracy. Kryteria poniżej odpowiadają obszarom omawianym w module; nie wprowadzają nowych wag ani progów ocen. Wiążące wymagania i zasady zaliczenia znajdują się w zadaniu kursowym.
|
Kryterium |
Przykład dowodu do wskazania |
|---|---|
|
Problem i pytania |
Plan raportu i zgodna z nim odpowiedź we wnioskach. |
|
Przygotowanie danych |
Notebook M2, audyt jakości i udokumentowane decyzje. |
|
Analiza w Pandas |
Jawne filtry, grupowania, miary i kontrole liczebności. |
|
Wizualizacja |
Wykresy z jednostkami, czytelnymi etykietami i zgodnymi tabelami. |
|
Interpretacja |
Wnioski powiązane z dowodami, bez nieuzasadnionej przyczynowości. |
|
Odtwarzalność |
Zapis udanego testu od wskazanego wejścia i opis środowiska. |
|
Kod i dokumentacja |
Czytelna kolejność komórek, zgodne nazwy oraz kompletne README. |
|
Użycie LLM |
Rzeczywisty rejestr, testy, werdykty i jawna odpowiedzialność autora. |
Przy każdym kryterium zanotuj lokalizację dowodu, status i ewentualną poprawkę. Statusy „potwierdzone”, „do poprawy” i „brak dowodu” są bardziej użyteczne niż ogólna ocena, że projekt wygląda dobrze. Jeśli nie korzystano z LLM w danym etapie, odnotuj to zgodnie z prawdą; nie twórz fikcyjnego wpisu dla zapełnienia rubryki.
Końcowy audyt trzech wniosków
Wybierz trzy najważniejsze zdania podsumowania. Dla każdego przejdź wstecz: wniosek, akapit wyników, tabela lub wykres, agregacja, filtr i źródło. Sprawdź jednostkę, n, zaokrąglenie i ograniczenie. Następnie upewnij się, że kod odtwarza tę samą liczbę po restarcie kernela.
Popraw przynajmniej jeden rzeczywiście wykryty problem i zapisz, jak sprawdzono poprawkę. Jeśli audyt niczego nie ujawnił, nie wymyślaj błędu; wykonaj dodatkową kontrolę i odnotuj jej wynik. Profesjonalna dokumentacja rozróżnia wykonaną pracę, zamiar i brak dowodu.
Sprawdź rozumienie 6
Notebook poprawnie wyeksportowano do HTML, ale nie uruchomiono po restarcie kernela. Co zostało potwierdzone, a czego nadal nie wiadomo? Dlaczego test w innym folderze nie jest tym samym co test w nowym środowisku?