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

88 update documentation #93

Merged
merged 17 commits into from
Dec 6, 2023
Merged

88 update documentation #93

merged 17 commits into from
Dec 6, 2023

Conversation

maho3
Copy link
Owner

@maho3 maho3 commented Nov 23, 2023

Updates all the documentation.

Also adds code coverage flags to the README.

@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once merged to your default branch, Codecov will compare your coverage reports and display the results in this comment.

Thanks for integrating Codecov - We've got you covered ☂️

@maho3 maho3 marked this pull request as draft November 23, 2023 11:30
@maho3 maho3 marked this pull request as ready for review November 23, 2023 16:42
@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

A lot of files have changed, but the biggest changes are:

  • Major updates to the main README.md
  • DATA.md has been removed, because it is primarily internal to LtU, though I will make it publicly available in ltu-cmass
  • All instances of 'summaries' when referring to model inputs have now been renamed 'data' (to be consistent with paper)

Also, I'm using this PR to piggyback some all-contributors tags

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @CompiledAtBirth for code, design, and reviewing pull requests

Copy link
Contributor

@maho3

I've put up a pull request to add @CompiledAtBirth! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors
please add @CompiledAtBirth for code, design, review, content
please add @maho3 for infra, content, research
please add @DeaglanBartlett for infra, content, research
please add @florpi for research
please add @axellapel for code, research, examples
please add @shivampcosmo for research, examples
please add @christopherlovell for research, examples, data, content
please add @laperezNYC for research, content
please add @tlmakinen for code, research

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @DeaglanBartlett for infra, content, research

Copy link
Contributor

@maho3

I've put up a pull request to add @DeaglanBartlett! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @florpi for research

Copy link
Contributor

@maho3

I've put up a pull request to add @florpi! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @axellapel for code, research, examples

Copy link
Contributor

@maho3

I've put up a pull request to add @axellapel! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @christopherlovell for research, examples, data, content

Copy link
Contributor

@maho3

I've put up a pull request to add @christopherlovell! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @shivampcosmo for research, examples

Copy link
Contributor

@maho3

I've put up a pull request to add @shivampcosmo! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @laperezNYC for research, content

Copy link
Contributor

@maho3

I've put up a pull request to add @laperezNYC! 🎉

@maho3
Copy link
Owner Author

maho3 commented Nov 23, 2023

@all-contributors please add @tlmakinen for code, research

Copy link
Contributor

@maho3

I've put up a pull request to add @tlmakinen! 🎉

@maho3 maho3 mentioned this pull request Dec 6, 2023
19 tasks
* converting prior arguments to tensors

* changes in tests to reflect new prior configurations

* adding an example of a torch.distributions prior in the tests to ensure it works. Adding stabilization of weight calculations into SBIRunner

Co-authored-by: Matt Ho <matthew.annam.ho@gmail.com>
Copy link
Collaborator

@DeaglanBartlett DeaglanBartlett left a comment

Choose a reason for hiding this comment

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

Very nice work! I have left a couple of comments where there may be typos

@maho3 maho3 merged commit 8b8b3e8 into main Dec 6, 2023
@maho3 maho3 deleted the 88-update-documentation branch December 6, 2023 17:12
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