hyperbase 0.8.0__tar.gz → 0.10.0__tar.gz

hyperbase-0.10.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

{hyperbase-0.8.0 → hyperbase-0.10.0}/CHANGELOG.md

@@ -1,19 +1,83 @@
 # Changelog
 
+## [0.10.0] - 11-04-2026
+
+### Added
+
+- `[]` pattern notation for specifying sequences of arguments.
+- EdgeType and ArgRole enums.
+- safety cap for match (`_MAX_ARGROLE_ITEMS=10`) against pathological edge arities.
+- caching of computed `Hyperedge`/`Atom` properties.
+- `parse_to_jsonl` method on `Parser`.
+- unified parameter interface for parsers.
+- method `Parser.accepted_params`.
+- maximum depth protection for parsers.
+- repl api for parsers.
+
+### Changed
+
+- multiple patterns functions are now `Hyperedge`/`Atom` methods: `is_wildcard`, `is_pattern`, `is_fun_pattern`, `is_variable`, `contains_variable`, `variable_name`.
+- `hyperbase.py` now delegating to smaller modules with well-defined concerns: `builders.py`, `correctness.py`, `transforms.py`, `patterns.checks.py` and `patterns.matcher.py`.
+- replaced `itertools.permutations` with constraint-propagated backtracking in argrole matcher.
+- `parse_text` renamed to `parse`; old iterator-based `parse` removed.
+- `read_source` renamed to `parse_source`; `read_source_to_jsonl` renamed to `parse_source_to_jsonl`.
+- renamed `sentensize` to `get_sentences`.
+- hedge now uses an explicit stack instead of recursion (so that pathologically
+    nested edge strings cannot exhaust Python's call stack).
+- renamed parsers.correctness to parsers.badness.
+
+### Removed
+
+- `__add__` operator overloading in `Hyperedge`/`Atom`.
+
+## [0.9.0] - 05-04-2026
+
+### Added
+
+- readers (txt, url, wikipedia).
+- cli interface with repl, parsers, readers.
+- hyperedge.Hyperedge.match function (calls parsers.match_pattern).
+- ParseResults.
+- HyperEdge.text.
+- load_edges function.
+
+### Changed
+
+- added get_parser to main functions (at hyperbase root).
+- improved documentation.
+- hedge now accepts ParseResults and can recursively add Hyperedge.text strings.
+- renamed function hyperedge.str2atom to str_to_atom.
+- Hyperedge is not a frozen dataclasse, instead of inheriting from tuple.
+- hedge now throws exceptions instead of returning None values.
+- Hyperedge.contains always recursive, removed deep argument.
+- simplified Hyperedge.simplify.
+- Hyperedge.insert_argrole now private, renamed to Hyperedge._insert_argrole.
+- Renamed Hyperedge.insert_edge_with_argrole to add_argument, pos optional (default to add at the end).
+- Renamed Hyperedge.edges_with_argrole to arguments_with_role.
+- Renamed Hyperedge.normalized to normalise.
+
+### Removed
+
+- function patterns.edge_matches_pattern.
+- deprecated and obsolete methods from Hyperedge: is_atom, to_str, roots, insert_first_argument, connect, sequence, contains_atom_type, main_concepts, replace_main_concept, has_argroles.
+
 ## [0.8.0] - 26-03-2026 - hyperbase is the successor of graphbrain
 
 ### Added
+
 - parser plugin foundation.
 - more comprehensive Hyperedge.check_correctness.
 - check parse correctness.
 - type checking: full code coverage.
 
 ### Changed
+
 - renamed library to hyperbase.
 - trimmed down library to the essentials: hyperedge, patterns and parser foundations.
 - converted documentation to Material for MkDocs.
 
 ### Removed
+
 - hypergraph module, hypergraph database (memory module).
 - alphabeta parser implementation.
 - old scripts, examples, processors.
@@ -23,7 +87,9 @@
 - obsolete constants.
 
 ## [0.7.0] - 05-03-2026
+
 ### Added
+
 - patterns.is_wildcard().
 - Base class hypergraph.memory.keyvalue.KeyValue for key-value hypergraph databases, removing redundant code between LevelDB and SQLite.
 - Tests for LevelDB (only the SQLite Hypergraph implementation was being directly tested).
@@ -35,6 +101,7 @@
 - Hypergraph.get_attributes().
 
 ### Changed
+
 - Entire project is now in pure Python
 - Python >=3.10 now required.
 - Hypergraph.search(), .match() and .count() now working with functional patterns and argument role matching.
@@ -44,19 +111,25 @@
 - Matches from patterns with repeated variables are collected in lists.
 
 ### Removed
+
 - graphbrain.logic obsolete module.
 - LevelDB backend
 
 ## [0.6.1] - 31-10-2022
+
 ### Changed
-- Hyperedge.replace_argroles() .insert_argrole() and .insert_edge_with_argrole() now works with functional patterns such as var.
+
+- Hyperedge.replace_argroles() .insert_argrole() and .add_argument() now works with functional patterns such as var.
 - Fixed bug when matching patterns containing atoms functional pattern where no atom has argroles.
 
 ### Removed
+
 - interactive_case_generator() from graphbrain.notebook.
 
 ## [0.6.0] - 27-10-2022
+
 ### Added
+
 - Hyperedge.atom and .not_atom properties.
 - Hyperedge.mtype() and .connector_mtype() methods.
 - Hyperedge.t, .mt, .ct and .cmt type shortcut properties.
@@ -65,12 +138,13 @@
 - Hypergraph.text().
 - Parser.parse_and_add().
 - Parser.sentences().
-- Hyperedge.normalized().
+- Hyperedge.normalise().
 - New package graphbrain.readers, for text readers from various sources.
 - New package graphbrain.processors, for miscellaneous processors.
 - Processor class.
 
 ### Changed
+
 - Coreference resolution now using the new spaCy experimental model.
 - Now using spaCy transformer GPU models by default, can fallback to CPU model.
 - Hyperedge.is_atom() deprecated.
@@ -84,6 +158,7 @@
 - Hyperedge.argroles() now also works at relation/concept level.
 
 ### Removed
+
 - graphbrain.patterns.normalize_edge().
 - graphbrain.stats obsolete package.
 - graphbrain.cognition obsolete package.
@@ -91,18 +166,22 @@
 - Hyperedge .predicate() and .predicate_atom().
 
 ## [0.5.0] - 28-07-2021
+
 ### Added
+
 - SQLite3 hypergraph database backend.
 - Hypergraph.add_with_attributes().
 - import and export commands.
 - Hypergraph context manager for batch writes (with hopen(hg_locator) as hg ...).
 
 ### Changed
+
 - Main hypergraph database backend is now SQLite3.
 - LevelDB backend becomes optional. (disabled by default)
 - Neuralcoref becomes optional. (disabled by default)
 
 ### Removed
+
 - Hypergraph.atom_count().
 - Hypergraph.edge_count().
 - Hypergraph.primary_atom_count().
@@ -111,21 +190,29 @@
 - corefs_unidecode agent.
 
 ## [0.4.3] - 22-04-2021
+
 ### Changed
+
 - Fixed AlphaBeta bug related to temporary atoms being removed too soon from atom2tokens.
 - Hypergraph.add_sequence() converts sequence name directly to atom.
 - Parser level coreference resolution (neuralcoref) disabled by default, requires dedicated build.
 
 ## [0.4.2] - 12-04-2021
+
 ### Changed
+
 - Solving wheel compilation issue.
 
 ## [0.4.1] - 07-04-2021
+
 ### Changed
+
 - Solving issue with inclusion of auxiliary data file in non-binary distributions.
 
 ## [0.4.0] - 07-04-2021
+
 ### Added
+
 - Agents system.
 - Conjunctions resolution agent.
 - Number agent (singular/plural relations) and related meaning.number module.
@@ -140,7 +227,7 @@
 - Function Hypergraph.sequences().
 - Function Hyperedge.replace_argroles().
 - Function Hyperedge.insert_argrole().
-- Function Hyperedge.insert_edge_with_argrole().
+- Function Hyperedge.add_argument().
 - Function Hyperedge.all_atoms().
 - Function Hyperedge.size().
 - Function Hyperedge.predicate().
@@ -150,6 +237,7 @@
 - Utility functions to show colored edges in the terminal.
 
 ### Changed
+
 - Special characters in atoms are now percent-encoded.
 - parse() now returns a dictionary that includes inferred edges.
 - parse() now returns a dictionary of edges to text.
@@ -165,25 +253,32 @@
 - Hyperedge.replace_atom() optional unique argument.
 
 ### Removed
+
 - Meta-modifier hyperedge type.
 - Auxiliary, subpredicate and dependency hyperedge types.
 - Obsolete Hyperedge.nest() method.
 
 ## [0.3.2] - 10-02-2020
+
 ### Added
+
 - simplify_role() on Atom objects produces an atom with only its simple type as role.
 
 ### Changed
+
 - Lemmas are now based on atoms with simplified roles.
 - Improved actors agent (more accurate identification of actors, English only for now).
 
 ## [0.3.1] - 03-02-2020
+
 ### Added
+
 - German parser (experimental and incomplete).
 - Documentation.
 - Hyperedge sequences.
 
 ### Changed
+
 - Improved hyperedge visualization in notebooks.
 - Agents receive language and sequence.
 - txt_parser agent creates a sequence.
@@ -192,11 +287,14 @@
 - Improved conflict agent.
 
 ## [0.3.0] - 28-09-2019
+
 ### Added
+
 - Tests.
 - Documentation.
 
 ### Changed
+
 - Graphbrain is now beta (main APIs considered stable).
 - LevelDB edge attributes encoded in JSON.
 - Renamed hypergraph() to hgraph() and moved function to __jnit__.
@@ -209,23 +307,29 @@
 - Improved notebooks visualizations (show(), blocks(), vblocks()).
 
 ### Removed
+
 - graphbrain.funs module.
 
 ## [0.2.2] - 13-09-2019
 
 ### Added
+
 - txt_parser agent.
 - MANIFEST.in to include VERSION file in distribution.
 
 ### Changed
+
 - Fixing 'pip install graphbrain' on Linux/Windows.
 
 ## [0.2.1] - 04-09-2019
+
 ### Added
+
 - claim_actors and corefs_dets agents.
 - meaning.concepts module.
 
 ### Changed
+
 - Fixed example.
 - hypergraph.sum_degree() and .sum_deep_degree().
 - Parser improvements.
@@ -233,11 +337,14 @@
 - Improved docs.
 
 ### Removed
+
 - Obsolete 'work-in-progress' code.
 - hg2json command.
 
 ## [0.2.0] - 04-08-2019
+
 ### Added
+
 - Primary entities and deep degrees.
 - Hyperedges have their own class, deriving from tuple.
 - Atoms have a special class, deriving from Hyperedge.
@@ -245,11 +352,15 @@
 - Created agent system + first agents.
 
 ### Changed
+
 - Parsers now have own package.
 
 ### Removed
+
 - Old experimental code.
 
 ## [0.1.0] - 14-06-2019
+
 ### Added
-- First release.
+
+- First release.

{hyperbase-0.8.0 → hyperbase-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperbase
-Version: 0.8.0
+Version: 0.10.0
 Summary: A foundational library for Semantic Hypergraphs
 Project-URL: Homepage, https://hyperquest.ai/hyperbase
 Author-email: "Telmo Menezes et al." <telmo@telmomenezes.net>
@@ -16,13 +16,19 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Requires-Python: >=3.10
+Requires-Dist: mwparserfromhell>=0.7.2
+Requires-Dist: prompt-toolkit>=3.0.0
+Requires-Dist: rich>=13.0.0
 Requires-Dist: tqdm>=4.65.0
+Requires-Dist: trafilatura>=2.0.0
 Provides-Extra: dev
+Requires-Dist: click==8.2.1; extra == 'dev'
 Requires-Dist: coverage>=7.4.3; extra == 'dev'
 Requires-Dist: mkdocs-material>=9.5; extra == 'dev'
 Requires-Dist: mkdocstrings[python]>=0.24; extra == 'dev'
 Requires-Dist: mypy>=1.8.0; extra == 'dev'
 Requires-Dist: pre-commit>=3.6.2; extra == 'dev'
+Requires-Dist: pytest>=9.0.0; extra == 'dev'
 Requires-Dist: ruff>=0.2.2; extra == 'dev'
 Requires-Dist: types-passlib>=1.7.7.20240106; extra == 'dev'
 Description-Content-Type: text/markdown

hyperbase-0.10.0/VERSION

@@ -0,0 +1 @@
+0.10.0

hyperbase-0.10.0/docs/assets/stylesheets/extra.css

@@ -0,0 +1,19 @@
+/* hyperquest.ai brand colors */
+:root,
+[data-md-color-scheme="default"] {
+  --md-primary-fg-color: #f1fffb;
+  --md-primary-fg-color--light: #f2f9f8;
+  --md-primary-fg-color--dark: #c6dfd9;
+  --md-primary-bg-color: #45847D;
+  --md-accent-fg-color: #6bcf7f;
+  --md-typeset-a-color: #45847D;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color: #f1fffb;
+  --md-primary-fg-color--light: #f2f9f8;
+  --md-primary-fg-color--dark: #c6dfd9;
+  --md-primary-bg-color: #45847D;
+  --md-accent-fg-color: #6bcf7f;
+  --md-typeset-a-color: #45847D;
+}

hyperbase-0.10.0/docs/installation.md

@@ -0,0 +1,141 @@
+# Installation
+
+Hyperbase requires Python >=3.10.
+
+## Install with pip
+
+```bash
+pip install hyperbase
+```
+
+## Install with uv
+
+[uv](https://docs.astral.sh/uv/) is a fast Python package manager. To add hyperbase to your project:
+
+```bash
+uv add hyperbase
+```
+
+Or to install it in a standalone environment:
+
+```bash
+uv pip install hyperbase
+```
+
+## Install from source
+
+Clone the repository and install:
+
+```bash
+git clone https://github.com/hyperbase/hyperbase.git
+cd hyperbase
+pip install .
+```
+
+Or using uv:
+
+```bash
+git clone https://github.com/hyperbase/hyperbase.git
+cd hyperbase
+uv sync
+```
+
+To run the tests from the project root:
+
+```bash
+pytest
+```
+
+Or using uv:
+
+```bash
+uv run pytest
+```
+
+## Parsers
+
+Hyperbase uses a plugin architecture for parsers. The core package does not include any parser, it only specifies the abstract parser interface. Parsers are installed separately as Python packages that register themselves via entry points.
+
+| Package | Plugin name | Description | License |
+| ------- | ----------- | ----------- | ------- |
+| `hyperbase-parser-ab` | `alphabeta` | AlphaBeta parser using spaCy | Open source (MIT) |
+| `hyperbase-parser-gen` | `generative` | Multilingual generative parser based on fine-tuned transformer model | Proprietary |
+
+AlphaBeta is the "classical" parser developed for Semantic Hypergraphs. It is based on spaCy and depends on its language models, that have to be installed to support a given language. It is released under the same permissive open source license as hyperbase (MIT).
+
+Generative is the "modern" multilingual parser, which produces high-quality parses for many languages. It is based on the fine-tuning of a more powerful transformer model and requires a GPU to run with acceptable speed. We plan on making this parser available for researchers and under a commercial license otherwise. Contact us if you are a researcher and wish to have early access to this parser.
+
+### Installing a parser
+
+Install a parser with pip:
+
+```bash
+pip install hyperbase-parser-ab
+```
+
+Or with uv:
+
+```bash
+uv add hyperbase-parser-ab
+```
+
+### AlphaBeta language support: installing spaCy models
+
+For example, for English language support:
+
+```bash
+python -m spacy download en_core_web_trf
+```
+
+Or with uv:
+
+```bash
+uv run python -m spacy download en_core_web_trf
+```
+
+Replace with the appropriate model from the table below.
+
+| Language | Code | Model |
+| -------- | ---- | ----- |
+| Chinese | `zh` | `zh_core_news_trf` |
+| English | `en` | `en_core_web_trf` |
+| French | `fr` | `fr_dep_news_trf` |
+| German | `de` | `de_dep_news_trf` |
+| Italy | `it` | `it_core_news_lg` |
+| Portuguese | `pt` | `pt_core_news_lg` |
+| Spanish | `es` | `es_dep_news_trf` |
+
+The table shows the languages that are currently configured. In principle, any language for which a [spaCy model](https://spacy.io/models/) is available can be supported. If you are interested in adding a language and can verify accuracy, please add a pull request or open an issue in the [plugin's repository](https://github.com/hyperquest-hq/hyperbase-parser-ab).
+
+### Verifying installation
+
+You can list all installed parsers with the CLI:
+
+```bash
+hyperbase parsers
+```
+
+```bash
+uv run hyperbase parsers
+```
+
+### Using parsers
+
+Once installed, parsers can be used from the interactive REPL:
+
+```bash
+hyperbase repl --parser alphabeta --lang en
+```
+
+```bash
+uv run hyperbase repl --parser alphabeta --lang en
+```
+
+Or programmatically:
+
+```python
+from hyperbase.parsers import get_parser
+
+parser = get_parser("alphabeta", lang="en")
+result = parser.parse_text("The sky is blue.")
+```

{hyperbase-0.8.0 → hyperbase-0.10.0}/docs/manual/api.md

@@ -8,14 +8,6 @@
 
 ::: hyperbase.hyperedge
 
-## Patterns module
-
-::: hyperbase.patterns
-
-## Parsers package
+## Parsers module
 
 ::: hyperbase.parsers
-
-### Parser module
-
-::: hyperbase.parsers.parser