wiki:cs/Pravidla

Version 9 (modified by Zuzana Nevěřilová, 10 years ago) (diff)

--

Pravidla provozu Centra zpracování přirozeného jazyka (CZPJ)

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

Informační systém CZPJ - nlpis

Na URL https://nlp.fi.muni.cz/nlpis/ najdete informační systém CZPJ 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 CZPJ 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 CZPJ 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.

Adresář projektu

Každý student, který spolupracuje s CZPJ, 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 ideálně 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 do archivu práce v IS MU.

Aspoň část projektu by měla být veřejně přístupná. Zveřejnění adresáře zajistíte pomocí souboru .htaccess v daném adresáři. Pokud chcete adresář projektu zcela otevřít, do .htaccess přidejte řádek Allow from all.

Pro vytvoření adresáře projektu můžete použít Šablonu stránky projektu.

Pozor na data CZPJ, která nejsou volně dostupná. Pokud s takovými daty pracujete, dejte pozor, ať je nezveřejníte. Můžete zveřejnit část nebo můžete přidat omezení na počet spuštění. Pokud si nejste jistí, zeptejte se zadavatele projektu.

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.

Projekt je aplikace

Pokud je projektem nějaký program, chceme jej využívat i potom, co CZPJ opustíte. Proto je v adresáři projektu 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].

Odpovědnost za data

Aby mohlo mít CZPJ 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.

Pokud si nejste jistí, zeptejte se. Je to jednodušší než čelit problémům kvůli neoprávněnému užití dat.

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 CZPJ.

Ohleduplné chování

Práce mnoha lidí na počítačích CZPJ 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ě server CZPJ 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.

Pokud vám zmizel proces, zeptejte se správců nlpunix, jestli jej třeba nezabili. Domluvte se se správci, že jsou vaše náročné procesy potřebné, nebo se naučte vytvářet procesy méně náročné.

Pozor na stahování cizích webů pomocí wget. Je to dobrý nápad, ale pokud provozovateli přetížíte server, nebude vás (ani CZPJ) mít rád. Mnoho dat máme stažených, takže se často stačí jen zeptat v CZPJ. Pokud musíte použít wget, nezapomeňte na časovou prodlevu.

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

Vzhledem k problémům Linuxu s dlouhodobě běžícími procesy se v CZPJ zakazuje spouštění dlouhodobě běžících procesů bez předchozí domluvy se správci počítačů CZPJ. 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 CZPJ o víkendu a v noci

Pokud usilovně pracujete na nějakém úkolu a rádi byste chodili do CZPJ 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 CZPJ 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 Centrum odstřežit. Při odchodu potom požádejte o opětné zastřežení.

Tisk v CZPJ

V CZPJ 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í CZPJ. Jinak totiž dochází k neodůvodněnému čerpání např. spotřebního materiálu - papíry, toner, ...

Jak se zachovat, když v CZPJ 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 CZPJ 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 „Centrum“, ale SVÝM JMÉNEM, s případným dodatkem, že se volající dovolal do CZPJ. U většiny telefonátů do Centra 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 CZPJ, irelevantní.

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

V CZPJ 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 CZPJ

CZPJ 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.