Skip to content

Commit e330fc7

Browse files
authored
Fix filesystem doc (RubixML#330)
Signed-off-by: Giuseppe Foti <[email protected]>
1 parent e1851ed commit e330fc7

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/persisters/filesystem.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,30 @@ Filesystems are local or remote storage drives that are organized by files and f
88
|---|---|---|---|---|
99
| 1 | path | | string | The path to the model file on the filesystem. |
1010
| 2 | history | false | bool | Should we keep a history of past saves? |
11-
| 3 | serializer | RBX | Serializer | The serializer used to convert to and from storage format. |
1211

1312
## Example
1413
```php
1514
use Rubix\ML\Persisters\Filesystem;
1615
use Rubix\ML\Serializers\RBX;
16+
use Rubix\ML\Classifiers\KNearestNeighbors;
17+
use Rubix\ML\Kernels\Distance\Manhattan;
1718

18-
$persister = new Filesystem('/path/to/example.model', true, new RBX());
19+
$persistable = new KNearestNeighbors(3, false, new Manhattan());
20+
$persister = new Filesystem('/path/to/example.rbx', true);
21+
$serializer = new RBX(6);
22+
$encoding = $serializer->serialize($persistable);
23+
$persister->save($encoding);
24+
```
25+
26+
## Example
27+
```php
28+
use Rubix\ML\Persisters\Filesystem;
29+
use Rubix\ML\Serializers\RBX;
30+
31+
$persister = new Filesystem('/path/to/example.rbx', true);
32+
$encoding = $persister->load();
33+
$serializer = new RBX(6);
34+
$persistable = $serializer->deserialize($encoding);
1935
```
2036

2137
## Additional Methods

0 commit comments

Comments
 (0)