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

Added Scrub & Benchmark commands to Farmer docs #286

Closed
wants to merge 3 commits into from
Closed

Added Scrub & Benchmark commands to Farmer docs #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23f8fc6
Add `scrub` & `benchmark` commands
ImmaZoni Oct 19, 2023
db8bf06
Update latest version
ImmaZoni Oct 19, 2023
ba0ad02
Updated Phrasing after discussion.
ImmaZoni Oct 24, 2023
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
16 changes: 16 additions & 0 deletions docs/protocol/substrate-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,6 +868,22 @@ In general you should be able to download the latest release, and re-start the N

There are some cases where version updates will cause issue with your Node & Farmer and you may have to wipe & purge your node, typically when errors occur. If you have any issues you can always check our [Forums](https://forums.subspace.network) and hop in our [Discord](https://discord.gg/subspace-network) Server to ask for help.

#### Benchmarking Your Farmer
Benchmarking helps you test the plotting speed of your farmer against different versions of the Subspace Network.

```
./subspace-farmer benchmark audit /path/to/your/plot
```
Replace /path/to/your/plot with the actual path to your plot. This will provide you with metrics and insights regarding plotting performance..

#### Scrubbing Your Farmer
In certain situations, especially when the farmer terminates unexpectedly or encounters an error, it might fail to restart correctly. The scrub command assists in resolving such issues by cleaning or resetting the specified plot.

```
./subspace-farmer scrub /path/to/your/plot
```
Ensure to replace /path/to/your/plot with your actual plot path. Use this command cautiously as it modifies the plot state to recover from errors. Regular backups are recommended.

#### Wipe & Purge

If you were running a node previously, and want to switch to a new snapshot, please perform these steps and then follow the guideline again:
Expand Down
16 changes: 16 additions & 0 deletions versioned_docs/version-latest/protocol/substrate-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,6 +868,22 @@ In general you should be able to download the latest release, and re-start the N

There are some cases where version updates will cause issue with your Node & Farmer and you may have to wipe & purge your node, typically when errors occur. If you have any issues you can always check our [Forums](https://forums.subspace.network) and hop in our [Discord](https://discord.gg/subspace-network) Server to ask for help.

#### Benchmarking Your Farmer
Benchmarking helps you test the plotting speed of your farmer against different versions of the Subspace Network.

```
./subspace-farmer benchmark audit /path/to/your/plot
```
Replace /path/to/your/plot with the actual path to your plot. This will provide you with metrics and insights regarding plotting performance..

#### Scrubbing Your Farmer
In certain situations, especially when the farmer terminates unexpectedly or encounters an error, it might fail to restart correctly. The scrub command assists in resolving such issues by cleaning or resetting the specified plot.

```
./subspace-farmer scrub /path/to/your/plot
```
Ensure to replace /path/to/your/plot with your actual plot path. Use this command cautiously as it modifies the plot state to recover from errors. Regular backups are recommended.

#### Wipe & Purge

If you were running a node previously, and want to switch to a new snapshot, please perform these steps and then follow the guideline again:
Expand Down
Loading