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.

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

Fix filesystem doc #330

Merged
merged 1 commit into from May 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/persisters/filesystem.md
Expand Up @@ -8,14 +8,30 @@ Filesystems are local or remote storage drives that are organized by files and f
|---|---|---|---|---|
| 1 | path | | string | The path to the model file on the filesystem. |
| 2 | history | false | bool | Should we keep a history of past saves? |
| 3 | serializer | RBX | Serializer | The serializer used to convert to and from storage format. |

## Example
```php
use Rubix\ML\Persisters\Filesystem;
use Rubix\ML\Serializers\RBX;
use Rubix\ML\Classifiers\KNearestNeighbors;
use Rubix\ML\Kernels\Distance\Manhattan;

$persister = new Filesystem('/path/to/example.model', true, new RBX());
$persistable = new KNearestNeighbors(3, false, new Manhattan());
$persister = new Filesystem('/path/to/example.rbx', true);
$serializer = new RBX(6);
$encoding = $serializer->serialize($persistable);
$persister->save($encoding);
```

## Example
```php
use Rubix\ML\Persisters\Filesystem;
use Rubix\ML\Serializers\RBX;

$persister = new Filesystem('/path/to/example.rbx', true);
$encoding = $persister->load();
$serializer = new RBX(6);
$persistable = $serializer->deserialize($encoding);
```

## Additional Methods
Expand Down