Skip to content

docs: document custom property shape model#35

Merged
Ramlaoui merged 1 commit into
mainfrom
docs/tensor-property-design
Jun 5, 2026
Merged

docs: document custom property shape model#35
Ramlaoui merged 1 commit into
mainfrom
docs/tensor-property-design

Conversation

@Ramlaoui
Copy link
Copy Markdown
Collaborator

@Ramlaoui Ramlaoui commented Jun 5, 2026

Summary

  • fold the custom property scope and tensor shape contract into the existing architecture data-model page
  • document molecule vs atom property ownership, value-level tensor shape, flat-batch constraints, and ASE ingestion rules in context
  • remove the standalone dev/design page so tensor properties are not a disconnected feature note

Validation

  • git diff --check
  • uv run --project atompack-py --group docs --locked --no-sync sphinx-build -b html docs/source /tmp/atompack-tensor-docs-sphinx-html

Sphinx build succeeds with the existing missing-image warnings from performance.rst.

@Ramlaoui Ramlaoui force-pushed the docs/tensor-property-design branch from 2e9666a to 5778553 Compare June 5, 2026 10:02
@Ramlaoui Ramlaoui changed the title docs: document tensor custom property contract docs: document custom property shape model Jun 5, 2026
@Ramlaoui Ramlaoui merged commit a4d09da into main Jun 5, 2026
5 checks passed
@Ramlaoui Ramlaoui deleted the docs/tensor-property-design branch June 5, 2026 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant