Skip to content

Commit

Permalink
updating docs for saving to be a bit clearer. (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
ncilfone committed Apr 14, 2022
1 parent 21c2c72 commit f8bd1e7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions website/docs/basics/Saving.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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`

Expand Down

0 comments on commit f8bd1e7

Please sign in to comment.