wiki:cs/Pravidla

Version 1 (modified by xkocinc, 6 years ago) (diff)

--

Pravidla provozu NLPlab


Jakmile se ocitnete v provozu NLPlab, měli byste dodržovat určitá pravidla, abyste nenabourali. Tady jsou:

Informační systém NLPlab - nlpis

Na URL https://nlp.fi.muni.cz/nlpis/ najdete informační systém NLPlab označovaný jako nlpis. Pro přístup použijte stejné heslo, jako máte na serveru aurora. V systému prosím zkontrolujte veškeré údaje spojené s vaší osobou a průběžně aktualizujte informace o vámi řešených projektech, případně úkolech.

Zprávy o činnosti

Povinností každého studenta spolupracujícího s NLPlab je pravidelně posílat zprávu o činnosti za uplynulý měsíc. Tato zpráva se zasílá přes webové rozhraní přístupné na https://nlp.fi.muni.cz/nlpis/auth/zpravy/ Postgraduální studenti posílají zprávy na konci každého měsíce, ostatní mají tuto povinnost vždy na konci října, listopadu, prosince, února, března, dubna a května. Zpráva je členěna podle jednotlivých projektů, na jejichž řešení se student podílí. Přehled zpráv za uplynulé měsíce je možné získat zde

Vzhledem k tomu, že každý student má právo číst zprávy o činnosti ostatních spolupracovníků, měl by mít každý možnost zjistit, na jakých úkolech a jak intenzivně se v NLPlab pracuje. Zprávy nemají tedy výhradně kontrolní funkci, ta je naopak tou poslední. Především by měly sloužit jako inspirace, jako informace, kdo řeší podobné problémy a kdo vám bude schopen pomoci, pokud máte výborný nápad, ale nemůžete "pohnout" s nějakým problémem.

Práce na projektech v NLPlab

Každý student, který spolupracuje s NLPlab, má přidělen jeden nebo více projektů ze seznamu na adrese https://nlp.fi.muni.cz/nlpis/auth/tasks-list.php. Tento seznam obsahuje celou škálu projektů s velmi rozdílnou složitostí - od (někdy, pro někoho) jednoduchého zprovoznění existujícího software, přes projekty vhodné pro bakalářské, případně diplomové práce, až po rozsáhlé projekty postgraduálních studentů, případně celých skupin řešitelů.

Všechny soubory, které se projektu týkají, musí být v adresáři /nlp/projekty/OZNACENI_PROJEKTU/. Zadavatel zprostředkuje vytvoření tohoto adresáře a nastavení vlastníka. Dále v systému nlpis vyplní řešitele a do URL dá odkaz na http://nlp.fi.muni.cz/projekty/OZNACENI_PROJEKTU/. Výjimkou z pravidla o uložení všech relevantních souborů na jedno místo mohou být velké datové soubory, které jsou vstupem/výstupem nějakých programů daného projektu a které se nacházejí v adresářích k tomu přímo určených (např. /nlp/corpora/*).

V adresáři /nlp/projekty/OZNACENI_PROJEKTU/ vytvoří student podadresář public_html/, do nějž umístí soubory, které mají být zveřejněny na adrese http://nlp.fi.muni.cz/projekty/OZNACENI_PROJEKTU/. V adresáři public_html/ vytvoří dále soubor, případně symbolický odkaz index.html, kde zachytí zpočátku cíle a plán projektu na další období, stanoví etapy a kontrolní body a, zejména, průběžně (nejméně na konci každého měsíce, v němž je projekt řešen) aktualizuje "changelog" projektu.

Pokud bude v adresáři public_html/ a jeho podadresářích další dokumentace projektu, musí být přístupná pomocí standardních odkazů ze souboru index.html. Například jako poslední "změna stavu" se v souboru index.html objeví informace o odevzdání diplomové práce spolu s odkazy na HTML podobu práce, postscriptový soubor atd.

Jak vypadá splněný úkol, resp. korektně uzavřený projekt

V adresáři /nlp/projekty/OZNACENI_PROJEKTU/ je povinně soubor README, který obsahuje minimálně základní informace o projektu: název projektu, stručné zadání, řešitele. Pokud byly v projektu použity ještě jiné zdroje (data), než jsou v adresáři projektu, musí být v tomto souboru také popsány. Soubor README slouží pouze pro rychlou informaci, když k adresáři projektu nepřistupujeme přes web. Pokud má být projekt viditelný na http://nlp.fi.muni.cz/projekty/ musí jej zadavatel projektu označit v nlpis.

V adresáři projektu je dále soubor Makefile, pomocí kterého se standardními prostředky (make) dají spustit minimálně akce:

  • make tar - vytvoří soubor OZNACENI_PROJEKTU.tgz, který bude obsahovat všechny potřebné soubory k přenesení projektu na jiný počítač;
  • make install - nainstaluje programy do zadaného adresáře, resp. adresářů;
  • make doc - vytvoří dokumentaci ve všech možných formátech (ps, html, txt). Tato akce má smysl, pokud píšete dokumentaci v SGML (to by bylo nejlepší) nebo TeXu?. Dokumentace by měla mimo jiné obsahovat podrobnější zadání, způsob řešení, popis použití výsledných programů. Příklady souborů Makefile, které definují některé z výše uvedených akcí, lze nalézt v adresářích: [ aurora:~pary/src/cqplib] a [ aurora:~pary/src/utils].
  • Pokud existuje HTML podoba finální verze dokumentace projektu, umístí se do adresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html/html/. Pokud se hlavní soubor přímo nejmenuje index.html, vytvoří se na hlavní soubor symbolický link. Postscript se uloží jako /nlp/projekty/OZNACENI_PROJEKTU/public_html/OZNACENI_PROJEKTU.ps, PDF jako /nlp/projekty/OZNACENI_PROJEKTU/public_html/OZNACENI_PROJEKTU.pdf, sbalené zdrojové kódy ke stažení jako /nlp/projekty/OZNACENI_PROJEKTU/public_html/OZNACENI_PROJEKTU.tgz, text ve formátu MS Word jako /nlp/projekty/OZNACENI_PROJEKTU/public_html/OZNACENI_PROJEKTU.doc. Zdrojové kódy v (La)TeXu? patří do /nlp/projekty/OZNACENI_PROJEKTU/public_html/tex/, povinný je Makefile v tomto adresáři.

    Pokud neexistuje soubor /nlp/projekty/OZNACENI_PROJEKTU/public_html/index.html, kde by byly odkazy na další soubory s dokumentací, zobrazí se při přístupu na http://nlp.fi.muni.cz/projekty/OZNACENI_PROJEKTU/ standardní výpis adresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html/. Odkaz na http://nlp.fi.muni.cz/projekty/OZNACENI_PROJEKTU/ je v systému nlpis (informačním systému NLPlab) zadán v položce ‘URL'.

Odpovědnost za data

Aby mohla mít NLPlab přístup k některým zdrojům, zavazuje se v mnoha případech, že zabrání neoprávněnému užití dat. Proto je každý odpovědný za ochranu svěřených dat, která používá při své práci. To zahrnuje mimo jiné i odpovědnost za správné nastavení přístupových práv ke spravovaným souborům a adresářům.

Datový prostor

Na disku, kde jsou domovské adresáře, funguje systém uživatelských kvót. Pokud v průběhu řešení nějakého úkolu zjistíte, že potřebujete větší diskový prostor, než povoluje vaše současná kvóta, požádejte zadavatele úkolu, aby zařídil její zvýšení. Větší projekty bývají umísťovány do zvláštního prostoru, kde se zpravidla systém kvót neaplikuje. Přesto i zde platí přísný zákaz použití přiděleného prostoru pro jiné účely, než bylo dohodnuto. Porušení tohoto zákazu může mít za následek pozastavení účtu (a byl už takový případ), případně definitivní zrušení spolupráce s NLPlab.

Počítače aurora a charon "vyvážejí" prostřednictvím protokolu SAMBA část diskového prostoru (/home/samba/) pro připojení z MS Windows jako (
aurora\home\samba\, resp.
charon\home\samba\). Soubory a adresáře umístěné do tohoto prostoru mohou být kdykoliv bez varování smazány. Přesto se doporučuje používat pro data s omezenou životností adresář tmp, který je v případě potřeby mazán přednostně. Do prostředí MS Windows je zakázáno instalovat nový software bez předchozí domluvy se správci laboratorních počítačů.

Ohleduplné chování

Práce mnoha lidí na počítačích NLPlab předpokládá ohleduplné jednání všech uživatelů. Před spuštěním jakéhokoliv programu s většími nároky na zdroje (ať už na paměť, procesor nebo diskové prostory) si prosím vždy ověřte, že nepatřičným způsobem neomezíte práci jiných uživatelů. Pokud je to možné, nezatěžujte zbytečně laboratorní server aurora spouštěním programů, které mohou běžet na jednotlivých stanicích. Jinak používejte v maximální míře unixového příkazu nice pro snížení priority vašich procesů a ověřujte si diskové možnosti pomocí programů df a du. Jste na unixu, využívejte jeho výhod. Velké soubory není například překvapivě třeba kopírovat, stačí vytvořit odkaz pomocí programu ln.

Zákaz spouštění dlouhodobě běžících procesů

Vzhledem k problémům Linuxu s dlouhodobě běžícími procesy se v NLPlab zakazuje spouštění dlouhodobě běžících procesů bez předchozí domluvy se správci laboratorních počítačů. Za obzvláště zavrženíhodné porušení tohoto zákazu se považuje spouštění programů typu rc5des, SETI, crack apod.

Pobyt v NLPlab o víkendu a v noci

Pokud usilovně pracujete na nějakém úkolu a rádi byste chodili do laboratoře o víkendu, případně zde setrvávali do pozdních nočních hodin, napište nám a my zařídíme doplnění příslušného seznamu oprávněných osob, který mají k dispozici vrátní. Provozní doba laboratoře tedy není omezená, nicméně o víkendech a o svátcích, resp. v nočních hodinách pracovních dnů, se musíte hlásit na vrátnici a nechat si laboratoř odstřežit. Při odchodu potom požádejte o opětné zastřežení.

Tisk v NLPlab

V NLPlab je spousta vybavení, např. barevná laserová tiskárna, které je vám k dispozici. Je jistě účelné tato zařízení využívat, nicméně je potřeba zamyslet se, jestli činnost, kterou provádíte, slouží přímo ku prospěchu akademického poslání NLPlab. Jinak totiž dochází k neodůvodněnému čerpání např. spotřebního materiálu - papíry, toner, ... Je ovšem možné, že jde o činnost, která slouží zájmům NLPlab jaksi nepřímo. A protože existují v životě Laboratoře události, které nespadají přímo do její akademické náplně, a přesto posilují jejího ducha (např. "Makrely"), vznikl nápad, jak je nepřímo podporovat. Pokud nemáte úplně čisté svědomí co se týče tisku, případně dalších výhod pobytu v NLPlab, můžete ulevit svému svědomí vložením odpustků do Kasičky. Nenajdete-li ji, zeptejte se kolegů. Vás příspěvek se určitě projeví ve zlepšené atmosféře celé Laboratoře. Bylo stanoveno, že jedna stránka barevného tisku ve fotografické kvalitě s pokrytím odpovídajícím bookletu CD má hodnotu 10 Kč. Vás příspěvek nechť je přiměřený pokrytí stránky.

Jak se zachovat, když v laboratoři zazvoní telefon

Možná se vám bude zdát, že tyto informace jsou nadbytečné, neboť je snad vše jasné. Delší pozorování dění v NLPlab však ukázalo, že tomu tak není. Obecně platí, že (pokud přirozená lenost dovolí), zvedají telefon služebně nejstarší v místnosti. Každopádně se však nikdo nehlásí jako "Laboratoř", ale SVÝM JMÉNEM, s případným dodatkem, že se volající dovolal do NLPlab. U většiny telefonátů do laboratoře platí, že volajícím je někdo z FI, a tudíž (až na několik málo výjimek) je pro něj informace, že vytočil číslo NLPlab, irelevantní.

Závěrečné doporučení

V NLPlab vznikla již celá řada užitečných nástrojů a pomocných prográmků. Přitom se stále opakuje případ, kdy se někdo pokouší "objevit Ameriku" a znovu implementuje programy, o jejichž existenci neví. To může být výhodné k procvičení programátorských dovedností, ale v prostředí, kde o nové (a snad i zajímavé) úkoly není nouze, je to značně kontraproduktivní. Na závěr tohoto bloku tedy jednoduché doporučení. Poptejte se po existujících zdrojích a hotových programech, ať se nedělá totéž dvakrát.

Šiřte slávu NLPlab

NLPlab stále hledá schopné spolupracovníky, neboť schopných lidí není nikdy dost. Proto, pokud víte o někom, kdo by byl dobrým adeptem, dejte nám tip, případně jej sami kontaktujte a pozvěte mezi nás.