Wybierz strukturę, którą potrafisz wyjaśnić
Utwórz folder z nazwą projektu, a następnie kilka miejsc o jasnych rolach. Nazwisko osoby czy dzisiejsza data nie zawsze wystarczą, by zrozumieć zawartość sześć tygodni później. Notatka umieszczona w katalogu głównym powinna wyjaśniać, gdzie są wejścia, trwające próby i wybrana dostawa.
Uniwersytet Cambridge zaleca wczesne ustalenie klasyfikacji i spójnych zasad nazewnictwa. Poniższy model to propozycja BriefGPU na małą sesję. Dostosuj go, jeśli Twoje oprogramowanie narzuca już strukturę projektu; nie przenoś powiązanych zasobów, nie sprawdzając, czy projekt je odnajduje.
| Emplacement proposé | Ce qu’il contient | Règle de travail |
|---|---|---|
| 00_lire-moi.txt | Cel, plan folderów i wybrana próba. | Aktualizuj istotne decyzje. |
| 01_entrees | Otrzymane źródła i zidentyfikowane wersje. | Nie zapisuj tam wyników przetwarzania. |
| 02_reglages | Parametry i wersje narzędzi dla każdej próby. | Zachowaj ustawienia faktycznie użyte. |
| 03_sorties/essai-01 | Wyniki zidentyfikowanego uruchomienia. | Utwórz inny folder na następną próbę. |
| 04_suivi | Inwentarz, dziennik i uwagi z walidacji. | Powiąż każdy wynik z jego źródłem. |
| 05_livraison/v01 | Wybór gotowy do przekazania. | Zidentyfikuj każdą nową wersję dostawy. |
Zadbaj, by otrzymane wejście pozostało rozpoznawalne
Przed pierwszym przetwarzaniem sporządź listę źródeł z ich pierwotną nazwą i lokalizacją. Zachowaj nienaruszoną wersję tych wejść, jak zaleca Cornell w przypadku danych surowych. Sama nazwa „oryginały” nie chroni zawartości: wskaż oprogramowaniu inny folder wyjściowy i sprawdź jego zachowanie na pliku próbnym.
Jeśli musisz przekonwertować lub przyciąć wejście przed obliczeniami, potraktuj to przygotowanie jako zidentyfikowany etap. Zachowaj powiązanie z otrzymanym źródłem. Będziesz wtedy mógł odróżnić wadę już obecną, problem z przygotowaniem i efekt przetwarzania GPU.
Gdy nowe źródło zastępuje stare, zapisz wersję i wyniki do przejrzenia. Nie nadpisuj po cichu pliku używanego przez próbę, którą chcesz zrozumieć. Zasada to zachowanie istotnego pochodzenia, a nie przechowywanie w nieskończoność wszystkich kopii roboczych.
Nadaj stały identyfikator każdej jednostce pracy
Krótki identyfikator, taki jak image-001, służy do śledzenia tego samego wejścia w wielu próbach. Jego rola nie zmienia się, gdy wynik zostanie zaakceptowany. Stan walidacji trzymaj w inwentarzu, zamiast bez przerwy zmieniać nazwy plików na „dobry”, „zły” czy „prawie-finalny”.
W przypadku stu wejść numery od 001 do 100 dają regularny punkt odniesienia. Dodaj odniesienie biznesowe, gdy jest potrzebne do dostawy. Nie zakładaj, że dwa pliki o nazwie photo.png otrzymane w dwóch różnych podfolderach oznaczają to samo. Pełna ścieżka wejścia musi pozostać powiązana z identyfikatorem.
Wybierz nazwy zgodne z narzędziami docelowymi. Windows rezerwuje między innymi dwukropek, znak zapytania i gwiazdkę; jego zwykłe zasady nie pozwalają też wiarygodnie odróżnić dwóch nazw wyłącznie po wielkości liter. Nazwa taka jak image-007_essai-02.png pozwala uniknąć tych niejasności. Sprawdź ograniczenia własnych pozostałych narzędzi, zamiast obiecywać uniwersalną zgodność.
Przykład: dwie próby, jedna kolekcja źródeł
Załóżmy, że otrzymano osiem obrazów w dwóch folderach. Inwentarz przypisuje obrazy od image-001 do image-008 i zachowuje ich pierwotne ścieżki. Pierwsze przejście korzysta z ustawień essai-01; wszystkie jego wyniki trafiają do odpowiedniego folderu. Defekt na image-003 i image-006 prowadzi do drugiej próby ograniczonej do tych dwóch pozycji.
Sześć zadowalających wyników pierwszej próby nie jest przeliczanych, aby folder był bardziej jednolity. Inwentarz wskazuje, który wynik został wybrany dla każdej pozycji. Dostawa v01 zawiera osiem plików o oczekiwanych nazwach, nawet jeśli ich pochodzenie rozkłada się między dwie próby. Ten przykład opisuje organizację, nie zakładając, że ustawienia z konieczności poprawiają wyniki.
| Entrée | Sortie retenue dans l’exemple | Réglages à retrouver | État |
|---|---|---|---|
| image-001 | 03_sorties/essai-01/image-001.png | 02_reglages/essai-01.txt | Zaakceptowane |
| image-003 | 03_sorties/essai-02/image-003.png | 02_reglages/essai-02.txt | Zaakceptowane po poprawce |
| image-006 | 03_sorties/essai-02/image-006.png | 02_reglages/essai-02.txt | Zaakceptowane po poprawce |
Zachowaj ustawienia w momencie próby
Plik o nazwie essai-02.txt może być zwykłą notatką, jeśli oprogramowanie nie potrafi wyeksportować swoich parametrów. Zapisz wersję narzędzia, ewentualny model, dotyczące wejścia i wybrane przez siebie wartości. Dodaj powód zmiany względem poprzedniej próby. Zrzut ekranu może uzupełnić notatkę, gdy parametry są widoczne tylko w oknie.
Unikaj pojedynczej notatki „aktualne ustawienia” zastępowanej po każdym przejściu. Wyjaśniałaby ona ostatnią próbę, ale nie starsze wyniki. Jeśli kilka prób używa tych samych parametrów, odwołaj się do tej samej zidentyfikowanej konfiguracji, zamiast niepotrzebnie ją kopiować.
Wersja oprogramowania i parametry ułatwiają wyjaśnienie wyniku; same jednak nie gwarantują identycznego odtworzenia. Niektóre aplikacje wymagają innych informacji lub zasobów. Postępuj zgodnie z ich dokumentacją, gdy potrzebne jest precyzyjne odtworzenie, zwłaszcza w przypadku stanu treningu.
Prowadź dziennik, który wyjaśnia decyzje
Dziennik uzupełnia inwentarz. Ten odpowiada na pytanie „na jakim etapie jest ta pozycja?”, a dziennik na pytanie „dlaczego coś zmieniliśmy?”. Wystarczy kilka opatrzonych datą wierszy: dotycząca próba, obserwacja, decyzja i następne sprawdzenie. Unikaj kopiowania każdego komunikatu oprogramowania, jeśli nikt nie będzie mógł z niego skorzystać.
Dla przykładu przydatny wiersz brzmiałby: „essai-01: niekompletne kontury na image-003 i image-006; powtórz te dwie pozycje z ustawieniem B; zachowaj pozostałe wyniki w oczekiwaniu na końcową walidację.” Po przeglądzie dodaj faktyczną decyzję. Nie przepisuj pierwotnej obserwacji tak, jakby defekt nigdy nie istniał.
Przejrzyj dzienniki techniczne przed ich przekazaniem: mogą zawierać prywatne ścieżki lub sposoby dostępu. Trzymaj sekrety oddzielnie od folderu dokumentacyjnego. Notatka przeznaczona dla współpracownika powinna wyjaśniać pracę z informacjami, których potrzebuje.
Rozróżnij klasyfikację, dostawę i kopię zapasową
Folder roboczy zachowuje próby istotne dla twojego rozumowania. Folder dostawy gromadzi to, co ma otrzymać odbiorca. Kopia zapasowa zachowuje niezbędne elementy w innym miejscu docelowym, z kontrolą kopiowania. Trzy foldery umieszczone obok siebie w tej samej przestrzeni same nie spełniają tych trzech funkcji.
Nie kopiuj wszystkich źródeł do każdego folderu prób. Powiąż wyniki z wejściami za pomocą inwentarza. Do dostawy przydatna może być wybrana kopia, aby przekazać samodzielny zestaw; zapisz wtedy jej pochodzenie i wersję. Do kopii zapasowej postępuj zgodnie z dedykowanym przewodnikiem, który szczegółowo opisuje inwentarz i weryfikację po transferze.
Zanim posprzątasz odrzucone warianty, sprawdź te, które wciąż są potrzebne do wyjaśnienia decyzji lub powtórzenia pracy. Ta organizacja nie narzuca żadnego okresu przechowywania. Pozwala zdecydować, co warto zachować, a następnie odnaleźć kopię, która jest punktem odniesienia.
Przeprowadź kontrolę na podstawie losowo wybranego wyniku
Wybierz plik dostawy, nie otwierając najpierw swojego oprogramowania. Na podstawie jego nazwy i inwentarza odnajdź jego wejście, próbę, która go wytworzyła, jej ustawienia i decyzję o akceptacji. Powtórz z wynikiem, który wymagał poprawki. Jeśli ścieżka zależy od twojej pamięci, w śledzeniu brakuje jakiegoś ogniwa.
Następnie sprawdź ilości: liczbę planowanych wejść, zatwierdzone wyniki, zablokowane elementy i wykluczone warianty. Dobrze uporządkowany folder może być wciąż niekompletny. Ten mały przegląd jest zakończony, gdy rozbieżności mają uzasadnienie i ktoś inny potrafi zrozumieć, których plików użyć.