{"author":"Milan Straka","author_email":"straka@ufal.mff.cuni.cz","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)","Programming Language :: C++","Programming Language :: Python","Programming Language :: Python :: 3","Topic :: Software Development :: Libraries"],"description":"ufal.udpipe\n============\n\nThe ``ufal.udpipe`` is a Python binding to UDPipe library .\n\nThe bindings is a straightforward conversion of the ``C++`` bindings API.\nIn Python 2, strings can be both ``unicode`` and UTF-8 encoded ``str``, and the\nlibrary always produces ``unicode``. In Python 3, strings must be only ``str``.\n\n\nWrapped C++ API\n---------------\n\nThe C++ API being wrapped follows. For a API reference of the original\nC++ API, see .\n\n::\n\n Helper Structures\n -----------------\n \n typedef vector Children;\n \n typedef vector Bytes;\n \n typedef vector Comments;\n \n class ProcessingError {\n public:\n bool occurred();\n string message;\n };\n \n class Token {\n public:\n string form;\n string misc;\n \n Token(const string& form = string(), const string& misc = string());\n \n // CoNLL-U defined SpaceAfter=No feature\n bool getSpaceAfter() const;\n void setSpaceAfter(bool space_after);\n \n // UDPipe-specific all-spaces-preserving SpacesBefore and SpacesAfter features\n string getSpacesBefore() const;\n void setSpacesBefore(const string& spaces_before);\n string getSpacesAfter() const;\n void setSpacesAfter(const string& spaces_after);\n string getSpacesInToken() const;\n void setSpacesInToken(const string& spaces_in_token);\n \n // UDPipe-specific TokenRange feature\n bool getTokenRange() const;\n size_t getTokenRangeStart() const;\n size_t getTokenRangeEnd() const;\n void setTokenRange(size_t start, size_t end);\n };\n \n class Word : public Token {\n public:\n // form and misc are inherited from token\n int id; // 0 is root, >0 is sentence word, <0 is undefined\n string lemma; // lemma\n string upostag; // universal part-of-speech tag\n string xpostag; // language-specific part-of-speech tag\n string feats; // list of morphological features\n int head; // head, 0 is root, <0 is undefined\n string deprel; // dependency relation to the head\n string deps; // secondary dependencies\n \n Children children;\n \n Word(int id = -1, const string& form = string());\n };\n typedef vector Words;\n \n class MultiwordToken : public Token {\n public:\n // form and misc are inherited from token\n int idFirst, idLast;\n \n MultiwordToken(int id_first = -1, int id_last = -1, const string& form = string(), const string& misc = string());\n };\n typedef vector MultiwordTokens;\n \n class EmptyNode {\n public:\n int id; // 0 is root, >0 is sentence word, <0 is undefined\n int index; // index for the current id, should be numbered from 1, 0=undefined\n string form; // form\n string lemma; // lemma\n string upostag; // universal part-of-speech tag\n string xpostag; // language-specific part-of-speech tag\n string feats; // list of morphological features\n string deps; // secondary dependencies\n string misc; // miscellaneous information\n \n EmptyNode(int id = -1, int index = 0) : id(id), index(index) {}\n };\n typedef vector EmptyNodes;\n \n class Sentence {\n public:\n Sentence();\n \n Words words;\n MultiwordTokens multiwordTokens;\n EmptyNodes emptyNodes;\n Comments comments;\n static const string rootForm;\n \n // Basic sentence modifications\n bool empty();\n void clear();\n virtual Word& addWord(const char* form);\n void setHead(int id, int head, const string& deprel);\n void unlinkAllWords();\n \n // CoNLL-U defined comments\n bool getNewDoc() const;\n string getNewDocId() const;\n void setNewDoc(bool new_doc, const string& id = string());\n bool getNewPar() const;\n string getNewParId() const;\n void setNewPar(bool new_par, const string& id = string());\n \n string getSentId() const;\n void setSentId(const string& id);\n string getText() const;\n void setText(const string& id);\n };\n typedef vector Sentences;\n \n \n Main Classes\n ------------\n \n class InputFormat {\n public:\n virtual void resetDocument(const string& id = string());\n virtual void setText(const char* text);\n virtual bool nextSentence(Sentence& s, ProcessingError* error = nullptr);\n \n static InputFormat* newInputFormat(const string& name);\n static InputFormat* newConlluInputFormat(const string& id = string());\n static InputFormat* newGenericTokenizerInputFormat(const string& id = string());\n static InputFormat* newHorizontalInputFormat(const string& id = string());\n static InputFormat* newVerticalInputFormat(const string& id = string());\n \n static InputFormat* newPresegmentedTokenizer(InputFormat tokenizer);\n \n static const string CONLLU_V1;\n static const string CONLLU_V2;\n static const string GENERIC_TOKENIZER_NORMALIZED_SPACES;\n static const string GENERIC_TOKENIZER_PRESEGMENTED;\n static const string GENERIC_TOKENIZER_RANGES;\n };\n \n class OutputFormat {\n public:\n virtual string writeSentence(const Sentence& s);\n virtual string finishDocument();\n \n static OutputFormat* newOutputFormat(const string& name);\n static OutputFormat* newConlluOutputFormat(const string& options = string());\n static OutputFormat* newEpeOutputFormat(const string& options = string());\n static OutputFormat* newMatxinOutputFormat(const string& options = string());\n static OutputFormat* newHorizontalOutputFormat(const string& options = string());\n static OutputFormat* newPlaintextOutputFormat(const string& options = string());\n static OutputFormat* newVerticalOutputFormat(const string& options = string());\n \n static const string CONLLU_V1;\n static const string CONLLU_V2;\n static const string HORIZONTAL_PARAGRAPHS;\n static const string PLAINTEXT_NORMALIZED_SPACES;\n static const string VERTICAL_PARAGRAPHS;\n };\n \n class Model {\n public:\n static Model* load(const char* fname);\n \n virtual InputFormat* newTokenizer(const string& options) const;\n virtual bool tag(Sentence& s, const string& options, ProcessingError* error = nullptr) const;\n virtual bool parse(Sentence& s, const string& options, ProcessingError* error) const;\n \n static const string DEFAULT;\n static const string TOKENIZER_PRESEGMENTED;\n };\n \n class Pipeline {\n public:\n Pipeline(const Model* m, const string& input, const string& tagger, const string& parser, const string& output);\n \n void setModel(const Model* m);\n void setInput(const string& input);\n void setTagger(const string& tagger);\n void setParser(const string& parser);\n void setOutput(const string& output);\n \n void setImmediate(bool immediate);\n void setDocumentId(const string& document_id);\n \n string process(const string& data, ProcessingError* error = nullptr) const;\n \n static const string DEFAULT;\n static const string NONE;\n };\n \n class Trainer {\n public:\n \n static Bytes* train(const string& method, const Sentences& train, const Sentences& heldout,\n const string& tokenizer, const string& tagger, const string& parser,\n ProcessingError* error = nullptr);\n \n static const string DEFAULT;\n static const string NONE;\n };\n \n class Evaluator {\n public:\n Evaluator(const Model* m, const string& tokenizer, const string& tagger, const string& parser);\n \n void setModel(const Model* m);\n void setTokenizer(const string& tokenizer);\n void setTagger(const string& tagger);\n void setParser(const string& parser);\n \n string evaluate(const string& data, ProcessingError* error = nullptr) const;\n \n static const string DEFAULT;\n static const string NONE;\n };\n \n class Version {\n public:\n unsigned major;\n unsigned minor;\n unsigned patch;\n string prerelease;\n \n // Returns current version.\n static version current();\n };\n\n\nExamples\n========\n\nrun_udpipe\n--------------\n\nSimple pipeline loading data (tokenizing on request), tagging, parsing and\nwriting to specified output format::\n\n\n import sys\n \n from ufal.udpipe import Model, Pipeline, ProcessingError # pylint: disable=no-name-in-module\n \n # In Python2, wrap sys.stdin and sys.stdout to work with unicode.\n if sys.version_info[0] < 3:\n import codecs\n import locale\n encoding = locale.getpreferredencoding()\n sys.stdin = codecs.getreader(encoding)(sys.stdin)\n sys.stdout = codecs.getwriter(encoding)(sys.stdout)\n \n if len(sys.argv) < 4:\n sys.stderr.write('Usage: %s input_format(tokenize|conllu|horizontal|vertical) output_format(conllu) model_file\\n' % sys.argv[0])\n sys.exit(1)\n \n sys.stderr.write('Loading model: ')\n model = Model.load(sys.argv[3])\n if not model:\n sys.stderr.write(\"Cannot load model from file '%s'\\n\" % sys.argv[3])\n sys.exit(1)\n sys.stderr.write('done\\n')\n \n pipeline = Pipeline(model, sys.argv[1], Pipeline.DEFAULT, Pipeline.DEFAULT, sys.argv[2])\n error = ProcessingError()\n \n # Read whole input\n text = ''.join(sys.stdin.readlines())\n \n # Process data\n processed = pipeline.process(text, error)\n if error.occurred():\n sys.stderr.write(\"An error occurred when running run_udpipe: \")\n sys.stderr.write(error.message)\n sys.stderr.write(\"\\n\")\n sys.exit(1)\n sys.stdout.write(processed)\n\n\nAUTHORS\n=======\n\nMilan Straka \n\n\nCOPYRIGHT AND LICENCE\n=====================\n\nCopyright 2016 Institute of Formal and Applied Linguistics, Faculty of\nMathematics and Physics, Charles University in Prague, Czech Republic.\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at http://mozilla.org/MPL/2.0/.\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://ufal.mff.cuni.cz/udpipe","keywords":"","license":"MPL 2.0","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"ufal.udpipe","package_url":"https://pypi.org/project/ufal.udpipe/","platform":null,"project_url":"https://pypi.org/project/ufal.udpipe/","project_urls":{"Homepage":"https://ufal.mff.cuni.cz/udpipe"},"provides_extra":null,"release_url":"https://pypi.org/project/ufal.udpipe/1.3.1.1/","requires_dist":null,"requires_python":"","summary":"Bindings to UDPipe library","version":"1.3.1.1","yanked":false,"yanked_reason":null}

Package search

ufal.udpipe

project_urls

Dependencies

All package metadata

Releases