Skip to content
New issue

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

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

Already on GitHub? # to your account

Documentation/sbachmei/mic 5097 5221 concepts #471

Conversation

stevebachmeier
Copy link
Contributor

@stevebachmeier stevebachmeier commented Aug 20, 2024

Add a results concept doc

Description

Changes and notes

Note that this also adds a bit to the model specification concept.

Testing

stevebachmeier and others added 3 commits August 20, 2024 16:16
* update docstrings
* pin sphinx-rtd-theme>=0.6
* various type hint updates
* change Stratification __call__() method stratify()
* move shared custom types to a new types.py module
docs/source/concepts/time.rst Show resolved Hide resolved
docs/source/concepts/results.rst Show resolved Hide resolved
docs/source/concepts/results.rst Show resolved Hide resolved
docs/source/concepts/results.rst Outdated Show resolved Hide resolved
docs/source/concepts/results.rst Outdated Show resolved Hide resolved
docs/source/concepts/results.rst Show resolved Hide resolved
@stevebachmeier stevebachmeier marked this pull request as draft August 21, 2024 15:19
@stevebachmeier stevebachmeier marked this pull request as ready for review August 21, 2024 15:50
Copy link
Contributor

@rmudambi rmudambi left a comment

Choose a reason for hiding this comment

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

Looks good once you fix the one reference to birth stratification. I think it's fine to keep all that detail about the Observation and Stratification objects since it's now below the usage docs.

from vivarium.framework.results import Observer

class BirthObserver(Observer):
Copy link
Contributor

Choose a reason for hiding this comment

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

This example should also refer to deaths

@stevebachmeier stevebachmeier merged commit 83f0812 into epic/results-documentation Aug 21, 2024
6 checks passed
@stevebachmeier stevebachmeier deleted the documentation/sbachmei/MIC-5097-5221-concepts branch August 21, 2024 20:49
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants