LPMN CLI Tool to narzędzie służące do komunikacji z serwerem zapytań LPMN za pomocą wiersza polecenia na lokalnym komputerze. Należy je pobrać przed uruchomieniem.
Pozwala na przetwarzanie tekstu według wybranego zapytania LPMN i wywołanie dowolnej usługi NLP Clarin poprzez wskazanie w zapytaniu właściwych jej narzędzi przetwarzania tekstu.
Praca z LPMN CLI Tool wymaga podstawowej znajomości obsługi wiersza polecenia.
Aby korzystać z LPMN CLI Tool należy:
Pobieranie następuje za pomocą menedżera projektów Python – pip. W wiersz polecenia należy wpisać komendę:
pip install --extra-index-url https://pypi.clarin-pl.eu/simple/ lpmn_client_biz
Poprawne pobranie powinno zakończyć się komunikatem z informacją zwrotną o pobranej wersji programu:
Successfully installed lpmn_client_biz-2.*
Aby sprawdzić poprawność pobierania, należy wpisać w wiersz polecenia komendę:
lpmn_client_biz
Jeśli program został poprawnie pobrany, zostanie wyświetlona informacja:
usage: lpmn_client_biz [-h] [-v] [-it {text,file,file_id}] [-o OUTPUT] [-ot {text,file,file_id}] [-f FILENAME] [-t TIMEOUT] [-u USERNAME] [-p PASSWORD] [--url URL] [-c CONFIG] lpmn input
Aby uruchomić LPMN CLI Tool, należy wprowadzić w wierszu poleceń poprawną składniowo komendę z zapytaniem lpmn. Na przykład:
lpmn_client_biz ['any2txt','morphodita',{'liner2':{'model':'n82'}}] "Ala ma kota" -u nazwa.uzytkownika@pwr.edu.pl -p "moje&haslo72" -ot text -v
Komenda zawierająca opis potoku przetwarzania tekstu powinna zawierać następujące elementy:
lpmn_client_biz – nazwa uruchamianego programu
Argumenty pozycyjne – elementy wymagane, muszą zostać wpisane w podanej kolejności:
lpmn – zapytanie lpmn w formie JSONa, czyli kolejność narzędzi do przetwarzania tekstu np.: ['any2txt','morphodita',{'liner2':{'model':'n82'}}]
Uwaga! Informacje dotyczące składni zapytania LPMN są dostępne tutaj.
input – dane wejściowe. Mogą być wpisane bezpośrednio w komendę np. "Ala ma kota" lub wprowadzone w postaci ścieżki do pliku na komputerze lokalnym, albo ścieżki na serwerze. W przypadku podania ścieżki do pliku lub na serwerze wymagane jest zdefiniowanie w komendzie opcji -it file/file_id. Podanie tekstu bezpośrednio w komendzie nie wymaga definiowania dodatkowych opcji, ponieważ tekst jest pobierany domyślnie.
Opcje – elementy dodatkowe, kolejność dowolna, mogą zostać wpisane lub nie w zależności od zadania:
-h – pomoc
-v – tryb gadatliwy czyli tryb informacji pełnej. Ten tryb wypisuje szczegółowe informacje o procesie wykonywanych operacji w formie m. in. paska postępu, dzięki czemu wiadomo, jaka część zadania została do przetworzenia.
-it – definiuje typ danych wejściowych według trzech możliwych:
text – zawarty w cudzysłowie tekst do przetworzenia wpisany w komendę np. "Ala ma kota". Jest to opcja zdefiniowana domyślnie, dlatego nie wymaga dodatkowego definiowana w komendzie.file – ścieżka do pliku, folderu lub folderu .zip na komputerze lokalnym zawierającym dane wejściowe. Wymaga zdefiniowania w komendzie jako: ~\plik.txt -it file. Typ danych wejściowych zależy od użytych narzędzi przetwarzania tekstu.file_id – ścieżka na serwerze do danych wejściowych pobieranych z serwera np. jako wynik poprzedniej operacji-o – definiuje nazwę folderu, w którym zostaną zapisane wyniki przetwarzania np. -o Zadanie1. Jeśli dany folder nie istnieje, zostanie utworzony. Możliwe jest też wskazanie ścieżki do folderu np. ~\Desktop\LPMN\Outputs\Zadanie1. Jeśli podana ścieżka nie istnieje, również zostanie utworzona, a dane wyjściowe zostaną zapisane w folderze końcowym.
-ot – określa typ danych wyjściowych. Podobnie jak w przypadku danych wejściowych istnieją trzy typy danych wyjściowych:
text – wyświetla w wierszu polecenia wynik przetwarzania tekstu, wymaga zdefiniowania jako -ot textfile – pobiera plik z wynikiem przetwarzania na lokalny komputer, jest to opcja zdefiniowana domyślniefile_id – ścieżka na serwerze do danych wyjściowych. Plik wyjściowy nie jest pobierany, lecz zwracana jest jego ścieżka na serwerze. Wymaga zdefiniowania jako -ot file_id.-f – pozwala zdefiniować nazwę pobranego pliku z wynikami przetwarzania. Podanie w komendzie: -f result.xml spowoduje utworzenie pliku .xml o nazwie result, w którym znajdować się będą wyniki przetwarzania. Brak zdefiniowanego -f spowoduje utworzenie domyślnej nazwy pliku. Plik jest zapisywany w folderze zdefiniowanym za pomocą -o.
Uwaga! Część narzędzi LPMN, np. TermoPL, zwraca dane wyjściowe w folderze .zip. W ich przypadku podanie -f result.xml nie spowoduje utworzenia pliku .xml, lecz result.zip.
-t – limit czasu na wykonanie zadania. Domyślnie program zakończy działanie po wykonaniu wszystkich operacji, dlatego opcja nie wymaga dodatkowego definiowana. W przypadku dużych operacji można ustawić limit czasu w sekundach np. -t 10. Jeśli limit czasu zostanie ustawiony i przekroczony, a przetwarzanie nie zostanie ukończone, zadanie zostanie anulowane i zostanie wyświetlony komunikat o błędzie.
-u – nazwa użytkownika taka jak w danych logowania do strony CLARIN-PL np. -u nazwa.uzytkownika@pwr.edu.pl. Wymaga zdefiniowania w komendzie.
-p – hasło użytkownika takie jak w danych logowania strony CLARIN-PL np. -p moje&haslo72. Wymaga zdefiniowania w komendzie.
Uwaga! Niektóre znaki specjalne wymagają użycia cudzysłowu: -p "moje&haslo72!".
Uwaga! Jeśli uwierzytelnianie użytkownika następuje za pomocą opcji -u i -p, należy je zdefiniować w komendzie.
-c – konfiguracja. Pozwala na uwierzytelnienie użytkownika za pomocą danych logowania do strony CLARIN-PL zapisanych na komputerze lokalnym bez konieczności podawania ich w komendzie.
Jeśli plik config.yml zostanie zapisany w dowolnej lokalizacji, ścieżkę do pliku należy zdefiniować w komendzie za pomocą np. -c ~\Desktop\LPMN\config.yml.
Definiowanie ścieżki nie jest wymagane, gdy plik został zapisany:
C:\Users\nazwa_użytkownika. Jeśli lpmn_client_biz jest uruchamiany z tej lokalizacji, bieżącym folderem jest nazwa_użytkownika. Bieżący folder można zmienić, uruchamiając lpmn_client_biz z innej lokalizacji.C:\Users\nazwa_uzytkownika\AppData\Local\.clarin\config.yml.Przygotowanie danych wejściowych zależy od wybranych usług przetwarzania tekstu. Mogą być podane w postaci tekstu w komendzie, ścieżki do pliku/folderu/folderu .zip lub ścieżki na serwerze.
Lokalizacja pobranego pliku z danymi wyjściowymi zależy od ustawień danych wyjściowych. Jeśli opcja -o zostanie zdefiniowana, plik zostanie pobrany do wskazanego folderu. Jeśli nie, plik zostanie pobrany do aktualnego katalogu roboczego (ang. current working directory).
W Windowsie po uruchomieniu wiersza polecenia domyślną lokalizacją użytkownika jest C:\Users\nazwa_użytkownika. Jeśli lpmn_client_biz jest uruchamiany z tej lokalizacji, jest ona domyślną lokalizacją pobierania. Można ją zmienić, uruchamiając lpmn_client_biz z innej lokalizacji.
Wynik przetwarzania będzie też dostępny na liście zadań zakończonych na stronie. Aby go pobrać, należy zalogować się do CLARIN-PL i w menu bocznym wybrać opcję Lista zadań. Aby przejść do listy poprawnie zakończonych zadań, należy wybrać opcję Zakończone. Pobrane wyniki zostaną zapisane na komputerze lokalnym w folderze Pobrane.
Typ danych wyjściowych zależy od wybranych usług przetwarzania tekstu.
Wersję aktualnie używanego narzędzia można sprawdzić za pomocą komendy:
pip show lpmn_client_biz
natomiast komenda:
pip install -U --extra-index-url https://pypi.clarin-pl.eu/simple/ lpmn_client_biz
zaktualizuje LPMN CLI Tool do najnowszej dostępnej wersji. Dostępność aktualizacji można sprawdzić, porównując lokalny numer wersji z najnowszą dostępną na serwerze PyPI.
Jeśli praca z LPMN CLI Tool została zakończona i narzędzie nie będzie potrzebne w przyszłości, można je usunąć za pomocą komendy:
pip uninstall lpmn_client_biz
Konieczne będzie potwierdzenie akcji przez wpisanie znaku y – yes w linii polecenia. Aby anulować usuwanie, należy wpisać n – no.
Jeśli dla pip nie na dodanego aliasu pip3, wszystkie komendy zaczynające się od pip należy wpisać jako pip3.
Informacje dotyczące pracy w Linuksie są dostępne w dokumencie LPMN Client. Przewodnik użytkownika w rozdziale [4] LPMN CLI Tool w systemie Linux.
(C) CLARIN-PL