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

Docs: How-To: Write custom rules #131

Merged
merged 1 commit into from
May 10, 2022
Merged

Conversation

chr5tphr
Copy link
Owner

Add a How-To on writing custom rules, specifically using

  • zennit.core.Hook for general Hooks, and
  • zennit.core.BasicHook for LRP-based Hooks

For zennit.core.Hook:

  • add explanations for backward and forward and zennit.core.Hook
  • give a short formal demonstration for the parts of the gradient in the
    backward function of Hook
  • introduce copying mechanics and Hooks with arguments

For zennit.core.BasicHook:

  • give a short description of the different functions used by BasicHook
  • give a rough formal definition of the computation done by BasicHook
    using the different functions
  • give a few examples, with a simple instance, and subclassing of
    BasicHook
  • explain the default values and mechanics for the BasicHook argument
    functions

Add a How-To on writing custom rules, specifically using
- zennit.core.Hook for general Hooks, and
- zennit.core.BasicHook for LRP-based Hooks

For zennit.core.Hook:
- add explanations for backward and forward and zennit.core.Hook
- give a short formal demonstration for the parts of the gradient in the
  backward function of Hook
- introduce copying mechanics and Hooks with arguments

For zennit.core.BasicHook:
- give a short description of the different functions used by BasicHook
- give a rough formal definition of the computation done by BasicHook
  using the different functions
- give a few examples, with a simple instance, and subclassing of
  BasicHook
- explain the default values and mechanics for the BasicHook argument
  functions
@chr5tphr chr5tphr merged commit b5077b8 into master May 10, 2022
@chr5tphr chr5tphr deleted the docs-write-custom-rules branch May 10, 2022 15:39
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.

None yet

1 participant