PENMAN notation for graphs (e.g., AMR)
Project description
Penman – a library for PENMAN graph notation
This package models graphs encoded in PENMAN notation (e.g., AMR), such as the following for the boy wants to go:
(w / want-01
:ARG0 (b / boy)
:ARG1 (g / go
:ARG0 b))
The Penman package may be used as a Python library or as a script.
For Javascript, see chanind/penman-js.
Features
- Read and write PENMAN-serialized graphs or triple conjunctions
- Read metadata in comments (e.g.,
# ::id 1234
) - Read surface alignments (e.g.,
foo~e.1,2
) - Inspect and manipulate the graph or tree structures
- Customize graphs for writing:
- Adjust indentation and compactness
- Select a new top node
- Rearrange edges
- Restructure the tree shape
- Relabel node variables
- Transform the graph
- Canonicalize roles
- Reify and dereify edges
- Reify attributes
- Embed the tree structure with additional
TOP
triples
- AMR model: role inventory and transformations
- Check graphs for model compliance
- Tested (but not yet 100% coverage)
- Documented (see the documentation)
Library Usage
>>> import penman
>>> g = penman.decode('(b / bark-01 :ARG0 (d / dog))')
>>> g.triples
[('b', ':instance', 'bark-01'), ('b', ':ARG0', 'd'), ('d', ':instance', 'dog')]
>>> g.edges()
[Edge(source='b', role=':ARG0', target='d')]
>>> print(penman.encode(g, indent=3))
(b / bark-01
:ARG0 (d / dog))
>>> print(penman.encode(g, indent=None))
(b / bark-01 :ARG0 (d / dog))
Script Usage
$ echo "(w / want-01 :ARG0 (b / boy) :ARG1 (g / go :ARG0 b))" | penman
(w / want-01
:ARG0 (b / boy)
:ARG1 (g / go
:ARG0 b))
$ echo "(w / want-01 :ARG0 (b / boy) :ARG1 (g / go :ARG0 b))" | penman --make-variables="a{i}"
(a0 / want-01
:ARG0 (a1 / boy)
:ARG1 (a2 / go
:ARG0 a1))
Demo
For a demonstration of the API usage, see the included Jupyter notebook:
-
View it on GitHub: docs/api-demo.ipynb
-
Run it on mybinder.org:
(Note: clear the output before running: Cell > All Output > Clear):
PENMAN Notation
A description of the PENMAN notation can be found in the
documentation.
This module expands the original notation slightly to allow for
untyped nodes (e.g., (x)
) and anonymous relations (e.g., (x : (y))
). It also accommodates slightly malformed graphs as well as
surface alignments.
Citation
If you make use of Penman in your work, please cite Goodman, 2020. The BibTeX is below:
@inproceedings{goodman-2020-penman,
title = "{P}enman: An Open-Source Library and Tool for {AMR} Graphs",
author = "Goodman, Michael Wayne",
booktitle = "Proceedings of the 58th Annual Meeting of the Association for Computational Linguistics: System Demonstrations",
month = jul,
year = "2020",
address = "Online",
publisher = "Association for Computational Linguistics",
url = "https://www.aclweb.org/anthology/2020.acl-demos.35",
pages = "312--319",
abstract = "Abstract Meaning Representation (AMR) (Banarescu et al., 2013) is a framework for semantic dependencies that encodes its rooted and directed acyclic graphs in a format called PENMAN notation. The format is simple enough that users of AMR data often write small scripts or libraries for parsing it into an internal graph representation, but there is enough complexity that these users could benefit from a more sophisticated and well-tested solution. The open-source Python library Penman provides a robust parser, functions for graph inspection and manipulation, and functions for formatting graphs into PENMAN notation. Many functions are also available in a command-line tool, thus extending its utility to non-Python setups.",
}
For the graph transformation/normalization work, please use the following:
@inproceedings{Goodman:2019,
title = "{AMR} Normalization for Fairer Evaluation",
author = "Goodman, Michael Wayne",
booktitle = "Proceedings of the 33rd Pacific Asia Conference on Language, Information, and Computation",
year = "2019",
pages = "47--56",
address = "Hakodate"
}
Disclaimer
This project is not affiliated with ISI, the PENMAN project, or the AMR project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file penman-1.3.1.tar.gz
.
File metadata
- Download URL: penman-1.3.1.tar.gz
- Upload date:
- Size: 101.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 584a95947544c197bcee0e8c837f89e6f6fb7998327c0274a4d2beb473d8e135 |
|
MD5 | c46884f7c8c84380506b84aef73bc9e0 |
|
BLAKE2b-256 | f40b7e3738226fb73afc7aa75cc314968bc78d3e3e8dc343296f54c47a2470a9 |
File details
Details for the file penman-1.3.1-py3-none-any.whl
.
File metadata
- Download URL: penman-1.3.1-py3-none-any.whl
- Upload date:
- Size: 43.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1444005a178e7ea2bcee2cc51c5f6aae6f7b1bb916a2764c7f1b5d0e304fcdca |
|
MD5 | da6f405a2a2855b4443ba3e04603af50 |
|
BLAKE2b-256 | 520ed1bf14d77b929a0d054561e6d78b9932a3c1bb76fac665fbfbcf410afec9 |