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.

Sign up for GitHub

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

Jump to bottom

API Reference, Stable versioning, Dev resources and standards #222

Merged
merged 19 commits into from
Dec 29, 2023
Merged

API Reference, Stable versioning, Dev resources and standards #222

merged 19 commits into from
Dec 29, 2023

Conversation

cnellington
Copy link
Owner

@cnellington cnellington commented Dec 28, 2023 •
edited
Loading

  • Updated docstring standard to Google format, started type-hinting as standard practice.
  • Added docstrings to public-facing contextualized.easy models and contextualized.analysis functions
  • Added API reference to the website for easy and analysis, autogenerated from docstrings
  • Updated website to newest jupyter-book, now allows searching documentation.
  • Updated package dependencies with stable version ranges, replaced pytorch-lightning with lightning (resolves Upgrade to lightning and pytorch 2 #181)
  • black formatted entire codebase
  • Increased minimum python version to 3.8
  • Added extra developer dependencies and scripts to standardize code formatting and documentation building.
  • Made website index page even more mobile responsive for Galaxy Fold users and their hotdog phones.

After this is merged, I will merge dev into main and publish a new release. All future PRs should respect docstring/type-hinting/formatting standards.

cnellington added 18 commits March 6, 2023 12:23
@cnellington
add initial readthedocs config
2cb66a2
@cnellington
add initial notebooks to readthedocs
c53422a
@cnellington
add notebooks
45aa124
@cnellington
add nb rendering requirements for readthedocs
6280b67
@cnellington
Merge branch 'dev' of https://github.com/cnellington/Contextualized i…
5e9bbcc 
…nto readthedocs
@cnellington
working autodoc with jupyter-book, upgraded versions of sphinx and ju…
b60cfe1 
…pyter-book to enable search
@cnellington
docs for easy module
c9b3702
@cnellington
finished docs for easy modules
ec54319
@cnellington
added dev resources
015fd5d
@cnellington
all tests passing locally with new requirements
7645efb
@cnellington
format all according to black, update version
3c3c75b
@cnellington
removed extra logo, now only in docs
1ac9d1f
@cnellington
made website more mobile responsive and updated name to Contextualize…
2a564d3 
…d ML
@cnellington
added recent publications to README
c95551e
@cnellington
added automatic style formatting and checking
89ddb8d
@cnellington
updated contributing
82baca0
@cnellington
fixed pandas toml dependency, added analysis docs
dc05263
@cnellington
remove robustness-to-outliers demo until it is fixed
62447c9
@review-notebook-app Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

blengerich
blengerich approved these changes Dec 29, 2023
View reviewed changes
Copy link
Collaborator

@blengerich blengerich left a comment

Choose a reason for hiding this comment

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

LGTM! Exciting!

@cnellington cnellington merged commit 7c31b71 into dev Dec 29, 2023
3 of 6 checks passed
@cnellington cnellington deleted the readthedocs branch December 29, 2023 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blengerich blengerich blengerich approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cnellington @blengerich