glazing 0.0.1__py3-none-any.whl

glazing/__init__.py

@@ -0,0 +1,34 @@
+"""Unified interface for FrameNet, PropBank, VerbNet, and WordNet linguistic resources.
+
+This package provides type-safe data models and utilities for working with
+four major linguistic resources. All models use Pydantic v2 for validation
+and support JSON Lines serialization.
+
+Modules
+-------
+framenet
+    Models and utilities for FrameNet semantic frames.
+propbank
+    Models and utilities for PropBank rolesets.
+verbnet
+    Models and utilities for VerbNet verb classes.
+wordnet
+    Models and utilities for WordNet synsets and relations.
+references
+    Cross-reference resolution between datasets.
+utils
+    Shared utilities and helper functions.
+
+Examples
+--------
+>>> from frames import FrameNet, PropBank, VerbNet, WordNet
+>>> fn = FrameNet.load("data/framenet.jsonl")
+>>> frames = fn.get_frames_by_lemma("give")
+"""
+
+from frames.__version__ import __version__, __version_info__
+
+__all__ = [
+    "__version__",
+    "__version_info__",
+]

glazing/__version__.py

@@ -0,0 +1,4 @@
+"""Version information for the glazing package."""
+
+__version__ = "0.0.1"
+__version_info__ = tuple(int(i) for i in __version__.split("."))

glazing/framenet/__init__.py

@@ -0,0 +1,31 @@
+"""FrameNet data models and utilities.
+
+This module provides models for FrameNet semantic frames, frame elements,
+lexical units, and their relationships. It supports the complete FrameNet
+annotation model including multi-layer annotations and valence patterns.
+
+Classes
+-------
+Frame
+    A semantic frame representing a schematic situation.
+FrameElement
+    A participant or prop in a frame.
+LexicalUnit
+    A word or phrase that evokes a frame.
+FrameRelation
+    Relationships between frames.
+
+Functions
+---------
+load
+    Load FrameNet data from JSON Lines.
+
+Examples
+--------
+>>> from frames.framenet import load
+>>> fn = load("data/framenet.jsonl")
+>>> frame = fn.get_frame("Giving")
+>>> print(frame.definition)
+"""
+
+__all__: list[str] = []

glazing/propbank/__init__.py

@@ -0,0 +1,31 @@
+"""PropBank data models and utilities.
+
+This module provides models for PropBank framesets, rolesets, semantic roles,
+and their mappings to other resources. It includes support for argument
+structure and lexical links with confidence scores.
+
+Classes
+-------
+Frameset
+    Container for all senses of a predicate.
+Roleset
+    A single sense of a predicate with its semantic roles.
+Role
+    Semantic role definition with argument number and description.
+RoleLink
+    Link from a role to VerbNet or FrameNet.
+
+Functions
+---------
+load
+    Load PropBank data from JSON Lines.
+
+Examples
+--------
+>>> from frames.propbank import load
+>>> pb = load("data/propbank.jsonl")
+>>> roleset = pb.get_roleset("give.01")
+>>> print(roleset.roles)
+"""
+
+__all__: list[str] = []

glazing/references/__init__.py

@@ -0,0 +1,30 @@
+"""Cross-reference models and resolution utilities.
+
+This module provides models and utilities for managing cross-references
+between FrameNet, PropBank, VerbNet, and WordNet. It includes confidence
+scoring, transitive mapping resolution, and conflict detection.
+
+Classes
+-------
+CrossReference
+    A mapping between entities in different datasets.
+MappingConfidence
+    Confidence scoring for mappings.
+UnifiedLemma
+    A lemma with representations across all datasets.
+MappingIndex
+    Bidirectional index for fast mapping lookups.
+
+Functions
+---------
+resolve_references
+    Resolve cross-references between datasets.
+
+Examples
+--------
+>>> from frames.references import CrossRef
+>>> xref = CrossRef(fn, pb, vn, wn)
+>>> mappings = xref.get_mappings("give", source="verbnet")
+"""
+
+__all__: list[str] = []

glazing/utils/__init__.py

@@ -0,0 +1,29 @@
+"""Shared utilities and helper functions.
+
+This module provides common utilities used across the package including
+XML parsing, validation, caching, and data conversion helpers.
+
+Functions
+---------
+parse_xml
+    Parse XML with namespace handling.
+validate_schema
+    Validate data against XSD or DTD schemas.
+create_cache
+    Create an LRU cache for query results.
+
+Classes
+-------
+LazyLoader
+    Lazy loading for large datasets.
+DataCache
+    Caching layer for frequently accessed data.
+
+Examples
+--------
+>>> from frames.utils import LazyLoader
+>>> loader = LazyLoader("data/large_dataset.json")
+>>> item = loader.get_item(123)  # Loads on demand
+"""
+
+__all__: list[str] = []

glazing/verbnet/__init__.py

@@ -0,0 +1,31 @@
+"""VerbNet data models and utilities.
+
+This module provides models for VerbNet verb classes, thematic roles,
+syntactic frames, and semantic predicates. It includes support for the
+complete role inheritance hierarchy and optional Generative Lexicon features.
+
+Classes
+-------
+VerbClass
+    A verb class with members, roles, and frames.
+Member
+    Individual verb with cross-references.
+ThematicRole
+    Semantic role with selectional restrictions.
+VNFrame
+    Syntactic-semantic frame pattern.
+
+Functions
+---------
+load
+    Load VerbNet data from JSON Lines.
+
+Examples
+--------
+>>> from frames.verbnet import load
+>>> vn = load("data/verbnet.json")
+>>> verb_class = vn.get_class("give-13.1")
+>>> print(verb_class.themroles)
+"""
+
+__all__: list[str] = []

glazing/wordnet/__init__.py

@@ -0,0 +1,31 @@
+"""WordNet data models and utilities.
+
+This module provides models for WordNet synsets, word senses, lexical and
+semantic relations. It supports the complete WordNet 3.1 database structure
+including morphological processing and relation traversal.
+
+Classes
+-------
+Synset
+    A set of cognitive synonyms representing a concept.
+Word
+    A lemma within a synset.
+Sense
+    A word-meaning pair with sense key.
+Pointer
+    A relation to another synset or word.
+
+Functions
+---------
+load
+    Load WordNet data from JSON Lines.
+
+Examples
+--------
+>>> from frames.wordnet import load
+>>> wn = load("data/wordnet.json")
+>>> synset = wn.get_synset("02084442")  # dog.n.01
+>>> print(synset.gloss)
+"""
+
+__all__: list[str] = []

glazing-0.0.1.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: glazing
+Version: 0.0.1
+Summary: A unified interface for FrameNet, PropBank, VerbNet, and WordNet
+Author-email: Aaron Steven White <aaron.white@rochester.edu>
+License: MIT
+Project-URL: Homepage, https://github.com/aaronstevenwhite/glazing
+Project-URL: Bug Reports, https://github.com/aaronstevenwhite/glazing/issues
+Project-URL: Source, https://github.com/aaronstevenwhite/glazing
+Project-URL: Documentation, https://glazing.readthedocs.io
+Keywords: nlp,linguistics,framenet,propbank,verbnet,wordnet,semantics,lexicon
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: typing-extensions>=4.9.0
+Requires-Dist: python-dateutil>=2.8.2
+Provides-Extra: dev
+Requires-Dist: ruff>=0.1.9; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: pytest>=7.4.3; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.1; extra == "dev"
+Requires-Dist: pre-commit>=3.6.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.3; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5.3; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
+Provides-Extra: xml
+Requires-Dist: lxml>=5.0.0; extra == "xml"
+Dynamic: license-file
+
+# glazing
+
+A Python package providing unified data models and interfaces for four linguistic resources: FrameNet, PropBank, VerbNet, and WordNet.
+
+## Features
+
+- Type-safe data models using Pydantic v2 for validation
+- Support for FrameNet 1.7 semantic frames and annotations
+- PropBank roleset and argument structure models
+- VerbNet verb classes with thematic role inheritance
+- WordNet 3.1 synsets and lexical relations
+- Cross-dataset reference resolution and mapping
+- Python 3.13+ with comprehensive type hints
+
+## Installation
+
+```bash
+pip install glazing
+```
+
+For development installation:
+
+```bash
+git clone https://github.com/aaronstevenwhite/glazing.git
+cd glazing
+pip install -e ".[dev]"
+```
+
+## Basic Usage
+
+```python
+from glazing import FrameNet, PropBank, VerbNet, WordNet
+
+# Load datasets from JSON Lines
+fn = FrameNet.load("data/framenet.jsonl")
+pb = PropBank.load("data/propbank.jsonl")
+vn = VerbNet.load("data/verbnet.jsonl")
+wn = WordNet.load("data/wordnet.jsonl")
+
+# Query by lemma
+abandon_frames = fn.get_frames_by_lemma("abandon")
+abandon_rolesets = pb.get_rolesets_by_lemma("abandon")
+abandon_classes = vn.get_classes_by_lemma("abandon")
+abandon_synsets = wn.get_synsets_by_lemma("abandon", pos="v")
+```
+
+## Data Formats
+
+The package uses JSON Lines as the primary data format. Original XML and database formats are converted to JSON Lines during data preparation, enabling efficient lazy loading of large datasets.
+
+### Data Conversion
+
+Convert source data to JSON Lines format:
+
+```python
+from glazing.converters import convert_framenet, convert_propbank, convert_verbnet, convert_wordnet
+
+# Convert from original formats
+convert_framenet("framenet_v17/", "data/framenet.jsonl")
+convert_propbank("propbank-frames/", "data/propbank.jsonl")
+convert_verbnet("verbnet/", "data/verbnet.jsonl")
+convert_wordnet("wn3.1/", "data/wordnet.jsonl")
+```
+
+## Cross-References
+
+The package maintains cross-references between datasets:
+
+```python
+from glazing.references import CrossRef
+
+xref = CrossRef(fn, pb, vn, wn)
+
+# Get related entries across datasets
+related = xref.get_related("give.01", source="propbank")
+print(related.verbnet_classes)  # ['give-13.1']
+print(related.framenet_frames)  # ['Giving']
+print(related.wordnet_senses)   # ['give%2:40:00', 'give%2:40:01']
+```
+
+## Requirements
+
+- Python 3.13+
+- pydantic >= 2.5.0
+- typing-extensions >= 4.9.0
+- python-dateutil >= 2.8.2
+
+## Documentation
+
+Full documentation is available at [https://glazing.readthedocs.io](https://glazing.readthedocs.io)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```bibtex
+@software{glazing2025,
+  author = {White, Aaron Steven},
+  title = {glazing: A Unified Interface for FrameNet, PropBank, VerbNet, and WordNet},
+  year = {2025},
+  url = {https://github.com/aaronstevenwhite/glazing}
+}
+```
+
+## Contributing
+
+Contributions are welcome. Please ensure all tests pass and code follows the project's style guidelines:
+
+```bash
+# Run tests
+pytest
+
+# Check code style
+ruff check src/ tests/
+
+# Type checking
+mypy src/
+```
+
+## Data Sources
+
+This package provides models for data from:
+
+- [FrameNet](https://framenet.icsi.berkeley.edu/)
+- [PropBank](https://propbank.github.io/)
+- [VerbNet](https://verbs.colorado.edu/verbnet/)
+- [WordNet](https://wordnet.princeton.edu/)

glazing-0.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+glazing/__init__.py,sha256=RzPVPuAA_x6Hjm7ANcePEihoyg2aVhIRRzoNn50fLv0,944
+glazing/__version__.py,sha256=EOUYSStwwU4SVirej_eYykWivIBw1IdF_IUg8o7hBdY,139
+glazing/framenet/__init__.py,sha256=_XG6baJKPMsdpS5dVKS0ePWnLDCx_xQWXDFlBzFKGuQ,745
+glazing/propbank/__init__.py,sha256=FHboMaNTzB6p92bdJ8fvzOeht1wKSAnI-X6DM_r3Xxg,759
+glazing/references/__init__.py,sha256=lF0kLPule5z_v-imCFRzWELiLB50kwEN6_0cK_cj6SY,806
+glazing/utils/__init__.py,sha256=tPaVcR0eLlLA9UcPoz-pxXUD1g7e86l4rS9noAs8hXY,679
+glazing/verbnet/__init__.py,sha256=D7I-rvZO5DSaADuSosD81G5eIPlsXCIPUaUBytF3ggc,752
+glazing/wordnet/__init__.py,sha256=US5G5RgH-fnYCu46Cpxh0BlMY4cIBj0JNRsXzAr1H-g,717
+glazing-0.0.1.dist-info/licenses/LICENSE,sha256=olLZM3gl2SkuF_v7NJ-V2ohGvftf94tev1wzqOfNHa0,1075
+glazing-0.0.1.dist-info/METADATA,sha256=LDYCLk0U1KEMm81UoYDuafcaJ7dkJkCMIsvByaUlxg8,5055
+glazing-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glazing-0.0.1.dist-info/top_level.txt,sha256=L4fEYOE4sVkfiXewXTX18kJyCRK6d9ROKNLKlWdQhEs,8
+glazing-0.0.1.dist-info/RECORD,,

glazing-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

glazing-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aaron Steven White
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

glazing-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+glazing