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

Set up cofi.utils and create Regularisation utilities #65

Merged
merged 14 commits into from
Oct 3, 2022
Merged

Conversation

jwhhh
Copy link
Member

@jwhhh jwhhh commented Sep 23, 2022

Aims to close #54

  • BaseRegularisation
  • QuadraticReg
  • Tests & coverage
  • Documentation for classes
  • Documentation for methods
  • Add findiff into dependency list (docs)
  • Review and confirmation on terms within the team

@jwhhh
Copy link
Member Author

jwhhh commented Sep 26, 2022

Hi @msambridge and @valentineap , could you please help check if the terminologies and documentation make sense?

  1. I created a base class BaseRegularisation in case we will have other kinds of regularisation later. Under that, the subclass QuadraticReg is the one we will mostly use (and it's the only subclass now). Is this setup ok / necessary?

  2. Please read this documentation page.

    1. Please let me know if terms like "QuadraticReg", "damping", "roughening", "flattening", "smoothing", "byo_matrix" can be made better / more accurate.
    2. Double-checking the formulae presented on this page would be great.
    3. It would also be nice to see if the example usages are intuitively understandable.
  3. Please let me know if there's a mistake in implementing the addition of two terms, by looking at the documentation of this function.

@jwhhh jwhhh marked this pull request as ready for review October 3, 2022 04:35
@jwhhh jwhhh merged commit f8ec9c9 into main Oct 3, 2022
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.

Utility functions using findiff to generate the difference matrices
1 participant