Documentation: dataset teminology consistency#1411
Conversation
Signed-off-by: zhen0427 <Zhen.Wang@alliander.com>
mgovers
left a comment
mgovers
left a comment
There was a problem hiding this comment.
good progress. here's a preliminary review because i noticed the (in)homogeneous thingy
| It is required when a component uses `DenseComponentData`, since dense representation relies on a fixed attribute order. | ||
|
|
||
| It may be omitted for components that only use `SparseComponentData`. | ||
|
|
There was a problem hiding this comment.
this is not correct. Both dense and sparse component data may or may not use Attributes. Instead, the Attributes section provides the list of attributes that is used when using use_compact_list=True (see also https://github.com/PowerGridModel/power-grid-model/pull/1411/changes#r3318722900 ).
Homogeneous / inhomogeneous is a different distinction, independent of sparse vs dense
| A [`ComponentData`](#json-schema-component-data-object) object is either a | ||
| [`HomogeneousComponentData`](#json-schema-homogeneous-component-data-object) object or an | ||
| [`InhomogeneousComponentData`](#json-schema-inhomogeneous-component-data-object) object | ||
| A [`ComponentData`](#json-schema-component-data-object) represents the data of a single component instance. | ||
|
|
||
| It can be stored in either dense or sparse representation: | ||
|
|
||
| - [`ComponentData`](#json-schema-component-data-object): | ||
| [`HomogeneousComponentData`](#json-schema-homogeneous-component-data-object) | | ||
| [`InhomogeneousComponentData`](#json-schema-inhomogeneous-component-data-object) | ||
| - [`DenseComponentData`](#json-schema-component-data-object-dense-representation) | ||
| - [`SparseComponentData`](#json-schema-component-data-object-sparse-representation) | ||
|
|
||
| #### JSON schema homogeneous component data object | ||
| #### JSON schema component data object (dense representation) |
There was a problem hiding this comment.
here and below, same as before: this is a different way of slicing.
Co-authored-by: Martijn Govers <martijn.govers@alliander.com> Signed-off-by: Zhen Wang <Zhen.Wang@alliander.com>
|
2 participants
This PR updates and aligns dataset terminology across the documentation and user-facing API comments.
Main changes :
This PR only contains documentation and comment updates. No functional code changes are included.