Skip to content
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.

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

Improvements to documentation #169

Merged
merged 8 commits into from
Mar 20, 2024
Merged

Improvements to documentation #169

merged 8 commits into from
Mar 20, 2024

Conversation

slwu89
Copy link
Member

@slwu89 slwu89 commented Mar 11, 2024

Addresses some of the issues in #168, and focus on improving the documentation experience for new users who may come across this library without background knowledge.

@slwu89 slwu89 marked this pull request as draft March 11, 2024 22:43
@slwu89 slwu89 marked this pull request as ready for review March 12, 2024 23:22
@slwu89
Copy link
Member Author

slwu89 commented Mar 12, 2024

Hi @mehalter, this PR is to improve the reading experience for people with little exposure to ACT coming across the library for the first time.

It also fixes the stratification of the SIRD and mask model here https://algebraicjulia.github.io/AlgebraicPetri.jl/stable/generated/covid/stratification/#Define-intervention-models which currently gives an incorrect result.

I do have 2 questions however:

  1. Is there any way to improve the mask-vax UWD here https://algebraicjulia.github.io/AlgebraicPetri.jl/stable/generated/covid/stratification/#Mask-Vax-Model ? It suffers from many of the problems the ACT approach hopes to fix (tedious code prone to user errors). Obviously doing a pullback with a multicospan would work, but that bypasses the UWD. I wonder if there is any elegant way to get that UWD using the categorical interface?
  2. The petri net generated from typed_product at the very end of this section https://algebraicjulia.github.io/AlgebraicPetri.jl/stable/generated/covid/disease_strains/#Define-a-new-type-system-and-corresponding-disease-and-multi-strain-models has extraneous transitions (e.g. :(strataU, :strataU)) because neither model actually uses those types. I'm not sure if you'd like to change that somehow, or just keep it as is and leave a note (as I did in the PR), since those type systems are needed for the further examples below.

Thanks, and happy for comments!

@slwu89 slwu89 requested a review from mehalter March 12, 2024 23:31
@jpfairbanks jpfairbanks merged commit 8828177 into AlgebraicJulia:main Mar 20, 2024
9 checks passed
@slwu89 slwu89 deleted the docs branch March 24, 2024 04:17
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.

2 participants