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

updating docs for saving to be a bit clearer. #242

Merged
merged 1 commit into from
Apr 14, 2022
Merged

updating docs for saving to be a bit clearer. #242

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
8 changes: 5 additions & 3 deletions website/docs/basics/Saving.md
View file
Open in desktop
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