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

Make the how-to more linear #19

Open
3 of 6 tasks
adjavon opened this issue Feb 25, 2025 · 0 comments
Open
3 of 6 tasks

Make the how-to more linear #19

adjavon opened this issue Feb 25, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@adjavon
Copy link
Contributor

adjavon commented Feb 25, 2025

The problems

  • Make the how-to into a how-to: currently it is somewhere in between a how-to and a tutorial and an explanation of the method

Main page

  • Flip tutorials and example gallery on the main page
  • Remove links in the text — there should only be one place to click and it should be obvious.
  • Move “What even is QuAC” to somewhere else… does not need to be in the main thing

Get started

  1. Preparation
    a. Data preparation
    b. Classifier preparation
    1. Training
    2. Saving it as jit-compiled
  2. Setting up the StarGAN
    1. Spell out all the options
    2. Training (don’t give the alternative version, only the YAML version)
      1. Setting up wandb for visualization
    3. Inference
  3. Attributions
    1. Creating attributions
    2. Evaluating your attributions
      1. Quantification
      2. Picking your examples

Advanced

  • Move detailed description here
  • add a "sharps" section
@adjavon adjavon self-assigned this Feb 25, 2025
@adjavon adjavon added the documentation Improvements or additions to documentation label Feb 25, 2025
@adjavon adjavon added this to the Updated documentation milestone Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant