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.

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

[docs] Update index.rst for surrogate gradient #437

Merged
merged 1 commit into from
Aug 11, 2023
Merged

[docs] Update index.rst for surrogate gradient #437

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ general-purpose Brain Dynamics Programming (BDP). Among its key ingredients, Bra
tutorial_toolbox/synaptic_weights
tutorial_toolbox/optimizers
tutorial_toolbox/saving_and_loading
tutorial_toolbox/surrogate_gradient
tutorial_toolbox/inputs


Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial_toolbox/saving_and_loading.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@
}
},
"source": [
"- ``bp.checkpoints.save_pytree(filename: str, target: PyTree, overwrite: bool = True, async_manager: Optional[AsyncManager] = None, verbose: bool = True,)`` \n",
"- ``bp.checkpoints.save_pytree(filename: str, target: PyTree, overwrite: bool = True, async_manager: Optional[AsyncManager] = None, verbose: bool = True)`` \n",
"function requires you to provide a `filename` which is the path where checkpoint files will be stored. \n",
"You also need to supply a `target`, which is a state dict object. \n",
"An optional `overwrite` argument allows you to decide whether to overwrite existing checkpoint files \n",
Expand All @@ -180,7 +180,7 @@
"new saves to ensure overwrite logic remains correct. \n",
"Finally, you can set the `verbose` argument to specify if you want to receive printed information about the operation.\n",
"\n",
"- ``.load_states(filename, verbose, check_missing)`` \n",
"- ``bp.checkpoints.load_pytree(filename: str, parallel: bool = True)`` \n",
"function allows you to restore data from a given checkpoint file \n",
"or a directory containing multiple checkpoints, which you specify with the `filename` argument. \n",
"If you set the `parallel` argument to true, \n",
Expand All @@ -196,7 +196,7 @@
"- ``.state_dict()`` \n",
"function retrieves the entire state of the module and returns it as a dictionary. \n",
"\n",
"- ``load_state_dict(self, state_dict: Dict[str, Any], warn: bool = True, compatible: str = 'v2')``\n",
"- ``.load_state_dict(self, state_dict: Dict[str, Any], warn: bool = True, compatible: str = 'v2')``\n",
"function is used to import parameters and buffers from a provided `state_dict` \n",
"into the current module and all its child modules. \n",
"You need to provide the function with a `state_dict`, \n",
Expand Down