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

Documentation #98

Draft
wants to merge 53 commits into
base: dev
Choose a base branch
from
Draft

Documentation #98

wants to merge 53 commits into from

Conversation

juan43ramirez
Copy link
Collaborator

Documentation PR for the "1.0.0" version of the code.

merajhashemi and others added 27 commits August 10, 2024 21:10
@merajhashemi
Fix typos
f89ffe3
@merajhashemi
Remove tox
c380330
@merajhashemi
Remove setup.cfg in tests
2531de4
@merajhashemi
Update dependencies
300518e
@merajhashemi
Fix mypy config
ca5464b
@merajhashemi
Bump ruff version
9f895a1
@merajhashemi
Simplify logic
b2a2f40
@merajhashemi
Add weights_only=True when using torch.load
a3892c2
@merajhashemi
Sort pyproject.toml
ba5e3a6
@merajhashemi
Add concurrency check to ci workflow
decb34a
@merajhashemi
Fix typo
c12ef60
@merajhashemi
Fix version tag glob in workflow
cbf9b07
@merajhashemi
Add workflow to test all supported python and PyTorch versions
103da3a
@merajhashemi
Fix typo
b71ba96
@merajhashemi
Fix workflow combination
26a6b31
@merajhashemi
Add cool badges To README
db6e262
@merajhashemi
Fix coverage badge color
fc53fa1
@merajhashemi
Refactor test helpers into separate testing package
54c3c3c
@merajhashemi
Remove tests and testing from coverage
2027c34
@merajhashemi
Remove numpy from core dependencies
0c0113c
@merajhashemi
Fix name
53850d7
@merajhashemi
Revert "Remove tests and testing from coverage"
a09334c 
This reverts commit 2027c34.
@merajhashemi
Improve README
de92a85
@merajhashemi
Add Simon to CITATION.cff
2a24261
@merajhashemi
Remove Makefile
134ad62
@merajhashemi
Update discord invite link
f7769ff
@juan43ramirez @merajhashemi
Progress on README
dabf6ee 
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez juan43ramirez added the documentation Improvements or additions to documentation label Aug 19, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 19, 2024 •
edited
Loading

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)		Lines missing
  testing
  __init__.py
  tests
  test_cmp.py
  tests/constraints
  test_constraint_state.py
  tests/multipliers
  conftest.py
  test_explicit_multipliers.py
  test_penalty_coefficients.py
  tests/pipeline
  conftest.py
  test_checkpoint.py
  test_convergence.py
  test_manual.py
Project Total  

This report was generated by python-coverage-comment-action

juan43ramirez and others added 26 commits August 20, 2024 17:13
@juan43ramirez @merajhashemi
Contributing guide
3385f6a 
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
Progress on README
3665c05
@merajhashemi
Bump ruff version
2bc9faf
@merajhashemi
Fix typos
b202b55
@merajhashemi
Bump jupytext version
05cab6e
@merajhashemi
Fix typos
c171622
@juan43ramirez @merajhashemi
Update README
87fd8de 
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
Documentation in Contributing
be7d393
@juan43ramirez
FAQ in separate file
91360d9
@juan43ramirez
FAQ progress
3b7cc89
@juan43ramirez @gallego-posada @merajhashemi
sanity_check_cmp function
5124749 
Co-authored-by: Jose Gallego-Posada <[email protected]>
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
FAQ progress
0e2018b
@juan43ramirez @merajhashemi
Constraints module progress
3f22392 
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
progress in problem.md
f3fabc2
@juan43ramirez
Formulation in problem
cf25370
@juan43ramirez
2022 -> 2024
49e6f6e
@juan43ramirez
Separate overview file + tex macros
3e22a2e
@juan43ramirez
overview
35da7bc
@juan43ramirez
problem.md
cfab154
@juan43ramirez
Edits
a4e18f1
@juan43ramirez
Formulations
d2dd3c0
@juan43ramirez @merajhashemi
Sort methods by source (not alphabetically)
d95e3aa 
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
Improvements to CMP file
b032d17
@juan43ramirez
Progress on optim
2ce0737
@juan43ramirez @gallego-posada @merajhashemi
cmp helper to func
63ad1c5 
Co-authored-by: Jose Gallego-Posada <[email protected]>
Co-authored-by: Meraj Hashemizadeh <[email protected]>
@juan43ramirez
Updates to README
c6c95ff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@merajhashemi merajhashemi

@juan43ramirez juan43ramirez

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@juan43ramirez @merajhashemi