Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
xl0 committed Jul 29, 2024
1 parent 79e6d71 commit e797637
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,12 @@ notebook.

### Config options

- environment: “jupyter” \| “vscode” \| “lab” \| “nbclassic”.
Auto-detected, don’t change or things might break. Ot do change, I’m
not your mom.
- autorun: bool. Whether to autorun cells. Default: True in Jupyter
nbclassic. Not supported in other environments.
- environment: “vscode” \| “lab” \| “nbclassic”. Auto-detected, don’t
change or things might break. Or do change it, I’m not your mom.
- autorun: bool. Autorun cells produced by the assistant. Default: True
in Jupyter nbclassic. Not supported in other environments.
- md_cells: bool. Use markdown cells for assistant replies. Default:
True in nbclassic, not supported in other environments. If zero, the
True in nbclassic, not supported in other environments. If False, the
cell output will be used for replies.
- comment_after_run: bool. Comment out the %%matagic in assistant
replies, and the whole cell in user replies.
Expand Down
6 changes: 3 additions & 3 deletions nbs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,9 @@
"The config is not saves anywhere, so you need to set things up in every notebook.\n",
"\n",
"### Config options\n",
"- environment: \"jupyter\" | \"vscode\" | \"lab\" | \"nbclassic\". Auto-detected, don't change or things might break. Ot do change, I'm not your mom.\n",
"- autorun: bool. Whether to autorun cells. Default: True in Jupyter nbclassic. Not supported in other environments.\n",
"- md_cells: bool. Use markdown cells for assistant replies. Default: True in nbclassic, not supported in other environments. If zero, the cell output will be used for replies.\n",
"- environment: \"vscode\" | \"lab\" | \"nbclassic\". Auto-detected, don't change or things might break. Or do change it, I'm not your mom.\n",
"- autorun: bool. Autorun cells produced by the assistant. Default: True in Jupyter nbclassic. Not supported in other environments.\n",
"- md_cells: bool. Use markdown cells for assistant replies. Default: True in nbclassic, not supported in other environments. If False, the cell output will be used for replies.\n",
"- comment_after_run: bool. Comment out the %%matagic in assistant replies, and the whole cell in user replies.\n",
"- model: claude-3-5-sonnet-20240620. Check https://docs.anthropic.com/en/docs/about-claude/models\n",
"- system_prompt: The system prompt, if you want to change it. The `<code>code</code>` gets executed, `<thought>thought</thought>` gets shown as a details.\n",
Expand Down

0 comments on commit e797637

Please sign in to comment.