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

Feature/docs #1011

Merged
merged 8 commits into from
Apr 29, 2024
Merged

Feature/docs #1011

merged 8 commits into from
Apr 29, 2024

Conversation

Jammy2211
Copy link
Collaborator

Documentation on building a scientific workflow.

@Jammy2211 Jammy2211 requested a review from rhayes777 April 24, 2024 06:55
Copy link

codecov bot commented Apr 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.77%. Comparing base (c287266) to head (4e2d1e7).
Report is 3 commits behind head on main.

❗ Current head 4e2d1e7 differs from pull request most recent head 1b9dc65. Consider uploading reports for the commit 1b9dc65 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1011      +/-   ##
==========================================
+ Coverage   80.75%   80.77%   +0.01%     
==========================================
  Files         198      198              
  Lines       14979    14983       +4     
==========================================
+ Hits        12096    12102       +6     
+ Misses       2883     2881       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines 14 to 15
Graphical models concisely describe these model and dataset dependencies and allow for
them to be fitted simultaneously, with a concise API and scientific workflow that ensures scalability to big datasets.

Choose a reason for hiding this comment

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

Suggested change
Graphical models concisely describe these model and dataset dependencies and allow for
them to be fitted simultaneously, with a concise API and scientific workflow that ensures scalability to big datasets.
Graphical models concisely describe these model and dataset dependencies, allowing them to be fitted simultaneously. This is achieved through a concise API and scientific workflow that ensures scalability to large datasets.

The parameters of this parent distribution are themselves inferred from the data, which for many problems enables
more robust and informative model fitting.

Anfull description of using hierarchical models is given below:

Choose a reason for hiding this comment

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

Suggested change
Anfull description of using hierarchical models is given below:
A full description of using hierarchical models is given below:

Hierarchical Models
-------------------

Hierarchical models are where multiple parameters in the model are assumed to be drawn from a common distributio.

Choose a reason for hiding this comment

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

Suggested change
Hierarchical models are where multiple parameters in the model are assumed to be drawn from a common distributio.
Hierarchical models are where multiple parameters in the model are assumed to be drawn from a common distribution.

Comment on lines 25 to 26
The parameters of this parent distribution are themselves inferred from the data, which for many problems enables
more robust and informative model fitting.

Choose a reason for hiding this comment

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

Suggested change
The parameters of this parent distribution are themselves inferred from the data, which for many problems enables
more robust and informative model fitting.
The parameters of this parent distribution are themselves inferred from the data, , enabling more robust and informative model fitting for many problems.

Search Grid Search
------------------

A classic method to perform model-fitting is a grid search, where the parameters of a model are divided on to a grid of

Choose a reason for hiding this comment

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

Suggested change
A classic method to perform model-fitting is a grid search, where the parameters of a model are divided on to a grid of
A classic method to perform model-fitting is a grid search, where the parameters of a model are divided onto a grid of

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for all the suggestions! Implemented :)

@Jammy2211 Jammy2211 merged commit 2b2e049 into main Apr 29, 2024
1 of 4 checks passed
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.

3 participants