From 61b048915d5fca4395fc07c8135f607dd0102dd4 Mon Sep 17 00:00:00 2001 From: Nicholas Cilfone Date: Thu, 14 Apr 2022 10:38:49 -0400 Subject: [PATCH] updating docs for saving to be a bit clearer. --- website/docs/basics/Saving.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/docs/basics/Saving.md b/website/docs/basics/Saving.md index 5fc9a4b8..6b5b415e 100644 --- a/website/docs/basics/Saving.md +++ b/website/docs/basics/Saving.md @@ -42,14 +42,16 @@ hidden_sizes = [ 32, 32, 16,] activation = "relu" ``` -### Specify spock Special Parameter Type +### Path Option 1: Specify spock Special Parameter Type We simply specify a `SavePath` in a spock config, which is a special argument type that is used to set the -save path from a configuration file. +save path from a configuration file. It can be imported from the top level `spock` path. Adding to: `tutorial.py` ```python +from spock import SavePath + class Activation(Enum): relu = 'relu' gelu = 'gelu' @@ -93,7 +95,7 @@ hidden_sizes: [32, 32, 16] activation: relu ``` -### Specify Path In-Line +### Path Option 2: Specify Path In-Line Here we simply specify the path when calling the `save()` method. In: `tutorial.yaml`