frgfm / torch-scan

Seamless analysis of your PyTorch models (RAM usage, FLOPs, MACs, receptive field, etc.)

https://frgfm.github.io/torch-scan/latest

Apache License 2.0

208 stars 22 forks source link

docs: Fixed README badge and updated documentation #70

Closed frgfm closed 2 years ago

frgfm commented 2 years ago

This PR introduces the following modifications:

fixes the README badge for documentation
fixes logo display in documentation
fixes the command name in the Makefile
adds a documentation edit button
fixes docstring examples for the new theme

codecov[bot] commented 2 years ago

Codecov Report

Merging #70 (ba5df85) into main (2240ea6) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #70   +/-   ##
=======================================
  Coverage   92.95%   92.95%           
=======================================
  Files          10       10           
  Lines         667      667           
=======================================
  Hits          620      620           
  Misses         47       47

Impacted Files	Coverage Δ
torchscan/crawler.py	`84.32% <ø> (ø)`