Skip to content

docs: improve README #1

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.

Sign up for GitHub

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

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# SuperDebug

## 使用方法：
Expand All @@ -21,7 +23,7 @@
3. 对于一些循环程序，你或许只想打印有限次，只需设置 `MAX_LOG = 想打印的次数` 即可
4. 如果你希望只打印变量的形状，而不打印变量的内容，可以使用 `debug(False, var)`
5. 打印完整矩阵内容，禁止pytorch、numpy自动省略：`FULL = True`
6. 对于一些套娃list / dict，可以控制详细打印至第几层，标准为0，建议用3： `PEEK_LAYER = 0`
6. 对于一些套娃list / dict，可以控制详细打印至第几层，标准为0，建议用3： `PEEK_LAYER = 3`

### 功能2: `debug()`

Expand Down