Skip to content

docs: use verb-first alias names in README examples and performance table #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Haigutus merged 1 commit into from
Jun 11, 2026
Merged

docs: use verb-first alias names in README examples and performance table #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ data = pandas.read_RDF([path])
You can then query a dataframe of all same type elements and its parameters across all [EQ, SSH, TP, SV etc.] instance files, where parameters are columns and index is object ID-s

```python
data.type_tableview("ACLineSegment")
data.tableview_by_type("ACLineSegment")
```

![image](https://user-images.githubusercontent.com/11408965/64228433-7eb7ef80-ceef-11e9-81d4-43e39ecf099d.png)
Expand Down Expand Up @@ -76,8 +76,8 @@ import triplets

data = polars.read_rdf(["grid_EQ.xml", "data.zip"]) # returns polars DataFrame

data.triplets.types_dict()
data.triplets.type_tableview("ACLineSegment")
data.triplets.get_types_count()
data.triplets.tableview_by_type("ACLineSegment")
data.triplets.filter_triplets(KEY="Type", VALUE=".*Generator.*", regex=True)
data.triplets.export_to_csv(export_to_memory=True)
data.triplets.export_to_nquads("/tmp/output.nq")
Expand All @@ -93,9 +93,9 @@ data = duckdb.connect() # in-memory
data = duckdb.connect("grid.duckdb") # persistent (no re-parsing next session)

data.read_rdf(["grid_EQ.xml", "data.zip"]) # parse via Arrow (zero-copy into DuckDB)
data.types_dict() # → dict
data.type_tableview("ACLineSegment").df() # → pandas DataFrame
data.type_tableview("ACLineSegment").pl() # → polars DataFrame
data.get_types_count() # → dict
data.tableview_by_type("ACLineSegment").df() # → pandas DataFrame
data.tableview_by_type("ACLineSegment").pl() # → polars DataFrame
data.filter_triplets(KEY="Type", VALUE=".*Sub.*", regex=True).df()
data.filter_triplets_by_type("Terminal").df()
data.references_to("some-uuid").df()
Expand All @@ -110,8 +110,8 @@ data.sql("SELECT VALUE, COUNT(*) FROM triplets WHERE KEY = 'Type' GROUP BY VALUE
All engines share the same `df.triplets.*` accessor:

```python
data.triplets.type_tableview("ACLineSegment")
data.triplets.types_dict()
data.triplets.tableview_by_type("ACLineSegment")
data.triplets.get_types_count()
data.triplets.filter_triplets(KEY="Type")
data.triplets.export_to_excel(export_to_memory=True)
data.triplets.export_to_nquads("/tmp/output.nq")
Expand All @@ -129,8 +129,8 @@ cim-diff original.xml modified.xml
| Operation | pandas | polars | DuckDB |
|-----------|--------|--------|--------|
| Parse (cython engine) | 128ms | 156ms | 283ms |
| type_tableview | 72ms | **21ms** | 53ms |
| tableview_by_type | 72ms | **21ms** | 53ms |
| filter_triplets_by_type | 103ms | **9ms** | 50ms |
| types_dict | 21ms | **11ms** | 18ms |
| get_types_count | 21ms | **11ms** | 18ms |

The old `rdf_parser.py` functions still work but emit deprecation warnings.
Loading