Skip to content

Update README.md#35

Merged
ryanpeach merged 1 commit into
mainfrom
ryanpeach-patch-5
May 11, 2026
Merged

Update README.md#35
ryanpeach merged 1 commit into
mainfrom
ryanpeach-patch-5

Conversation

@ryanpeach
Copy link
Copy Markdown
Owner

Great job making a new implementation!

Here are some tasks to complete before merging this PR:

Styleguide

  • Did you update the version in Cargo.toml?

Jupyter

  • Add references to the bottom of the notebook.
  • Make sure it runs on cpu and gpu
  • Comment the shapes of any numpy arrays or torch tensors. Make assertions on the output.
  • Functions that have more than one parameter should have a * before the first or second parameter to force the user to use named arguments, unless there is only one parameter.
  • Do not set default values, you might forget to pass parameters up the stack.
  • Add the proper headers to the notebook:
%load_ext autoreload
%autoreload 2
  • Make sure the jupyter notebook is importable without running any code. Most cells should look like this:
def foo():
    pass

if __name__ == '__main__':
    foo()

Marksman

  • Make marksman notes and anki flash cards.
  • Use singular nouns for filenames.
  • Use - in filenames instead of spaces.
  • For any new notes, you need to go back in other notes and link to them using project search.
  • Put sources on each flashcard. Mark AI as the source if you used AI to generate the flashcard. These can be revisited later. Mark yourself as the source if you wrote the flashcard yourself.

@ryanpeach ryanpeach merged commit 7477146 into main May 11, 2026
1 check passed
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.

1 participant