Skip to content

Documentation: dataset teminology consistency#1411

Draft
zhen0427 wants to merge 13 commits into
mainfrom
feature/documentation-consistency
Draft

Documentation: dataset teminology consistency#1411
zhen0427 wants to merge 13 commits into
mainfrom
feature/documentation-consistency

Conversation

@zhen0427
Copy link
Copy Markdown
Member

This PR updates and aligns dataset terminology across the documentation and user-facing API comments.

Main changes :

  • introducing consistent terminology for:
    • buffer type (row-based / columnar)
    • buffer representation (dense / sparse)
    • component data uniformity (uniform / non-uniform)
    • serialization representation (compact_list / named_map)
  • removing legacy terminology such as:
    • scenario homogeneity
    • attribute homogeneity
    • IDs match
  • updating Serialization.md
  • updating dataset terminology documentation
  • updating Python API docstrings for dense/sparse batch representations and indptr behavior

This PR only contains documentation and comment updates. No functional code changes are included.

Signed-off-by: zhen0427 <Zhen.Wang@alliander.com>
@zhen0427 zhen0427 added the documentation Improvements or additions to documentation label May 28, 2026
Copy link
Copy Markdown
Member

@mgovers mgovers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good progress. here's a preliminary review because i noticed the (in)homogeneous thingy

Comment thread docs/user_manual/dataset-terminology.md
Comment thread docs/user_manual/serialization.md Outdated
Comment thread docs/user_manual/serialization.md
Comment thread src/power_grid_model/_core/power_grid_model.py
zhen0427 and others added 4 commits May 29, 2026 10:28
Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Zhen Wang <Zhen.Wang@alliander.com>
Signed-off-by: zhen0427 <Zhen.Wang@alliander.com>
Signed-off-by: zhen0427 <Zhen.Wang@alliander.com>
Comment thread docs/examples/Power Flow Example.ipynb Outdated
Comment thread docs/user_manual/serialization.md Outdated
Comment thread docs/user_manual/dataset-terminology.md Outdated
Comment thread docs/user_manual/dataset-terminology.md Outdated
Comment thread docs/user_manual/dataset-terminology.md Outdated
Comment thread docs/user_manual/dataset-terminology.md Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 3, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants