From 9ba08c61ff84b428159e1e61ebc721c4c0975b55 Mon Sep 17 00:00:00 2001 From: Nikolaus Georgi Date: Fri, 27 Sep 2024 13:20:58 +0700 Subject: [PATCH] Initial commit --- .gitignore | 5 + LICENSE | 201 ++++++++++++++++++++++++++++++ README.md | 60 +++++++++ id_svo_extractor/__init__.py | 2 + id_svo_extractor/pipeline.py | 38 ++++++ id_svo_extractor/svo_extractor.py | 113 +++++++++++++++++ id_svo_extractor/utils.py | 17 +++ pyproject.toml | 46 +++++++ requirements.txt | 1 + 9 files changed, 483 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 id_svo_extractor/__init__.py create mode 100644 id_svo_extractor/pipeline.py create mode 100644 id_svo_extractor/svo_extractor.py create mode 100644 id_svo_extractor/utils.py create mode 100644 pyproject.toml create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..848913c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.idea/ +venv*/ +__pycache__/ +dist/ +id_svo_extractor.egg-info/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d7f905 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +![(id, svo, extractor)](https://i.imgur.com/FqUBo68.png) + +# id-svo-extractor + +**id-svo-extractor** is a heuristic tool designed to extract SVO (Subject-Verb-Object) triples from Indonesian text. It uses Stanza's state-of-the-art Indonesian language pipeline for NLP. + +## Requirements + +To use **id-svo-extractor**, you will need Python v3.10 or higher and the following Python package: +- [spacy-stanza](https://github.com/explosion/spacy-stanza) v1.0.4 + +You must also download Stanza's Indonesian models for `tokenize`, `mwt`, `pos`, `lemma`, and `depparse` processors before initializing the pipeline. + +## Installation + +Install the package directly from PyPI: + +```sh +pip install id-svo-extractor +``` + +## Usage + +Here's a basic example to get you started. + +```python +from id_svo_extractor import create_pipeline +from id_svo_extractor.utils import collect_svo_triples +from stanza import download + + +# Download Stanza's Indonesian models for tokenize, mwt, pos, lemma, and depparse processors. +# This step is mandatory before initializing the NLP pipeline. +download("id", processors="tokenize,mwt,pos,lemma,depparse") + +# Initialize the NLP pipeline. +nlp = create_pipeline() + +doc = nlp("Niko dan Okin mendesain brosur promosi dan mencetak poster iklan.") + +for sentence in doc.sents: + # Extracted triples for each sentence are stored in `svo_triples` custom attribute. + print(sentence._.svo_triples) + # Output: + # [ SVOTriple(s=[Niko], v=[mendesain], o=[brosur, promosi]), + # SVOTriple(s=[Okin], v=[mendesain], o=[brosur, promosi]), + # SVOTriple(s=[Niko], v=[mencetak], o=[poster, iklan]), + # SVOTriple(s=[Okin], v=[mencetak], o=[poster, iklan]) ] + +print(collect_svo_triples(doc)) +# Output: +# [ ('Niko', 'mendesain', 'brosur promosi'), +# ('Okin', 'mendesain', 'brosur promosi'), +# ('Niko', 'mencetak', 'poster iklan'), +# ('Okin', 'mencetak', 'poster iklan') ] +``` + +## License + +This project is licensed under the Apache License 2.0. \ No newline at end of file diff --git a/id_svo_extractor/__init__.py b/id_svo_extractor/__init__.py new file mode 100644 index 0000000..be72ae9 --- /dev/null +++ b/id_svo_extractor/__init__.py @@ -0,0 +1,2 @@ +from id_svo_extractor import utils +from id_svo_extractor.pipeline import create_pipeline diff --git a/id_svo_extractor/pipeline.py b/id_svo_extractor/pipeline.py new file mode 100644 index 0000000..a056f79 --- /dev/null +++ b/id_svo_extractor/pipeline.py @@ -0,0 +1,38 @@ +from spacy import Language, prefer_gpu +from spacy.tokens import Span +from spacy_stanza import load_pipeline + +from id_svo_extractor.svo_extractor import extract_svo_triples + + +LANG = "id" + + +def create_pipeline( + package: str = "default", + processors: str | dict = "tokenize,mwt,pos,lemma,depparse", + use_gpu: bool = True, + download_method="reuse_resources", + **kwargs, +) -> Language: + if "depparse" not in processors: + raise ValueError( + "The 'depparse' processor is required and was not found in the provided 'processors' argument." + ) + + if use_gpu: + prefer_gpu() + + nlp = load_pipeline( + name=LANG, + lang=LANG, + package=package, + processors=processors, + use_gpu=use_gpu, + download_method=download_method, + **kwargs, + ) + + Span.set_extension("svo_triples", getter=extract_svo_triples, force=True) + + return nlp diff --git a/id_svo_extractor/svo_extractor.py b/id_svo_extractor/svo_extractor.py new file mode 100644 index 0000000..bfe9a24 --- /dev/null +++ b/id_svo_extractor/svo_extractor.py @@ -0,0 +1,113 @@ +from collections import defaultdict, namedtuple +from itertools import product +from operator import attrgetter + +from spacy.tokens import Span, Token + + +SVOTriple = namedtuple("SVOTriple", ["s", "v", "o"]) + + +def is_prepositional_nmod(nmod: Token) -> bool: + return any(token.dep_ == "case" for token in nmod.lefts) + + +def expand_noun(noun: Token) -> list[Token]: + def _expand_noun(_noun): + _noun_phrase = [_noun] + for token in _noun.children: + if token.pos_ in {"NOUN", "PROPN", "ADJ"} and token.dep_ in { + "flat:name", + "compound", + "nmod", + "amod", + }: + if token.dep_ == "nmod" and is_prepositional_nmod(token): + continue + for conjunct in token.conjuncts: + if conjunct.pos_ in {"NOUN", "PROPN", "ADJ"}: + _noun_phrase.extend(_expand_noun(conjunct)) + for token_ in conjunct.lefts: + if token_.dep_ in {"cc", "punct"}: + _noun_phrase.append(token_) + _noun_phrase.extend(_expand_noun(token)) + return _noun_phrase + + noun_phrase = _expand_noun(noun) + noun_phrase.sort(key=attrgetter("i")) + return noun_phrase + + +def extract_args(head_noun: Token) -> list[list[Token]]: + arguments = [expand_noun(head_noun)] + for conjunct in head_noun.conjuncts: + if conjunct.pos_ in {"NOUN", "PROPN"}: + arguments.append(expand_noun(conjunct)) + return arguments + + +def dist_subjs_mods_to_verb_conjs(verbs) -> None: + for verb, details in verbs.items(): + head = verbs.get(verb.head) + if head is not None and verb.dep_ == "conj": + if not details.get("subjects") and head.get("subjects"): + details["subjects"] = head["subjects"] + if not details.get("modifiers") and head.get("modifiers"): + details["modifiers"] = head["modifiers"] + return None + + +def dist_objs_to_verb_conjs(verbs) -> None: + for verb, details in verbs.items(): + if objects := details.get("objects"): + for conjunct in verb.conjuncts: + conj = verbs.get(conjunct) + if conj is not None and conjunct.i < verb.i and not conj.get("objects"): + conj["objects"] = objects + return None + + +def handle_xcomp_subjs(verbs) -> None: + for verb, details in verbs.items(): + head = verbs.get(verb.head) + if head is not None and verb.dep_ == "xcomp" and details.get("objects"): + details["subjects"] = head.get("objects") or head["subjects"] + return None + + +def extract_svo_triples(sentence: Span) -> list[SVOTriple]: + svo_triples = [] + verbs = defaultdict(lambda: defaultdict(list)) + + for token in sentence: + head = token.head + if token.pos_ == "VERB": + verb = verbs[token] + if token.dep_ in {"acl", "acl:relcl"} and head.pos_ in {"NOUN", "PROPN"}: + verb["subjects"].extend(extract_args(head)) + elif head.pos_ == "VERB": + head = verbs[head] + if token.pos_ in {"NOUN", "PROPN"}: + if token.dep_ in {"nsubj", "nsubj:pass"}: + head["subjects"].extend(extract_args(token)) + elif token.dep_ == "obj": + head["objects"].extend(extract_args(token)) + elif token.dep_ in {"advmod", "aux"}: + head["modifiers"].append(token) + + dist_objs_to_verb_conjs(verbs) + handle_xcomp_subjs(verbs) + dist_subjs_mods_to_verb_conjs(verbs) + + for verb, details in verbs.items(): + subjects = details.get("subjects") + objects = details.get("objects") + if subjects and objects: + vp = [verb] + if verb_modifiers := details.get("modifiers"): + vp.extend(verb_modifiers) + vp.sort(key=attrgetter("i")) + for s, o in product(subjects, objects): + svo_triples.append(SVOTriple(s=s, v=vp, o=o)) + + return svo_triples diff --git a/id_svo_extractor/utils.py b/id_svo_extractor/utils.py new file mode 100644 index 0000000..c9a06be --- /dev/null +++ b/id_svo_extractor/utils.py @@ -0,0 +1,17 @@ +from spacy.tokens import Doc, Token + + +def merge_tokens_into_text(tokens: list[Token]) -> str: + text = "".join(token.text_with_ws for token in tokens) + return text.rstrip() + + +def collect_svo_triples(doc: Doc) -> list[tuple[str, str, str]]: + svo_triples = [] + for sentence in doc.sents: + for s, v, o in sentence._.svo_triples: + s = merge_tokens_into_text(s) + v = merge_tokens_into_text(v) + o = merge_tokens_into_text(o) + svo_triples.append((s, v, o)) + return svo_triples diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..4764170 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,46 @@ +[build-system] +requires = ["setuptools>=68.2.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "id-svo-extractor" +version = "0.2.0" +requires-python = ">=3.10" +description = "id-svo-extractor: Extract SVO triples from Indonesian text." +readme = "README.md" +license = { file = "LICENSE" } + +dependencies = [ + "spacy-stanza==1.0.4" +] + +authors = [ + { name = "Nikolaus Georgi", email = "int.nxgeo@gmail.com" } +] + +maintainers = [ + { name = "Nikolaus Georgi", email = "int.nxgeo@gmail.com" } +] + +keywords = [ + "SVO extraction", + "Indonesian NLP", + "Stanza", + "information extraction", + "text analysis" +] + +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Intended Audience :: Education", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering :: Artificial Intelligence", + "Programming Language :: Python :: 3.10", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent" +] + +[project.urls] +Homepage = "https://github.com/nxgeo/id-svo-extractor" +Repository = "https://github.com/nxgeo/id-svo-extractor.git" \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..56330e4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +spacy-stanza==1.0.4 \ No newline at end of file