Skip to content

Commit

Permalink
Update use-cases-guide.md
Browse files Browse the repository at this point in the history
grammar nits
  • Loading branch information
jeanniefinks committed Jul 12, 2023
1 parent 558bf72 commit f85445e
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/use-cases-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ limitations under the License.

# Sparsify Use Cases Guide

To use Sparsify, you must specify a use case for all experiments run.
To use Sparsify, you must specify a use case for all experiments to run.
A use case is the specific task or domain/sub-domain you wish to sparsify a model for such as image classification, object detection, or text classification.
It is used to enable Sparsify to apply the best sparsification techniques for your use case, to automatically package the model for deployment, and depending on what is run, to load specific pipelines for data loading and training.

Expand All @@ -32,26 +32,26 @@ The generally supported use cases for Sparsify currently are:
- NLP - token classification: `nlp-token_classification`
- NLP - named entity recognition: `nlp-named_entity_recognition`

Note, other aliases are recognized for these use cases such as image-classification for cv-classification.
Note, other aliases are recognized for these use cases, such as image-classification for cv-classification.
Sparsify will automatically recognize these aliases and apply the correct use case.

### Custom Use Cases

If you wish to use Sparsify for a use case that is not in the list of currently supported use cases, you can use a custom use case for some pathways in Sparsify.
The custom use cases will be saved into the Sparsify cloud for future reuse when run through a supported pathway.
The custom use cases will be saved into the Sparsify Cloud for future reuse when run through a supported pathway.
The pathways that support custom use cases are listed below.

Note, custom use cases will prevent Sparsify from applying known, domain specific knowledge for sparsification of your model.
Additionally, it will prevent autofill of the pre and post processing functions when creating a deployment package.
Note, custom use cases will prevent Sparsify from applying known, domain-specific knowledge for the sparsification of your model.
Additionally, it will prevent autofill of the pre- and post-processing functions when creating a deployment package.

#### One Shot
#### One-Shot

For One Shot experiments, both the CLIs and APIs always support custom use cases.
To utilize, run a one shot experiment with `--use-case` set to the desired custom use case.
For One-Shot Experiments, both the CLIs and APIs always will support custom use cases.
To utilize, run a One-Shot Experiment with `--use-case` set to the desired custom use case.

### Training Aware
### Training-Aware

For Training Aware experiments, custom use cases are only supported with the APIs for custom integrations.
This is because non-custom integrations utilize plugins that corresponding to the appropriate use case for training pipelines.
For Training-Aware Experiments, custom use cases are only supported with the APIs for custom integrations.
This is because non-custom integrations utilize plug-ins that correspond to the appropriate use case for training pipelines.
To utilize this, ensure that you have a training pipeline ready to go and inject the Sparsify API into the training pipeline with the desired use case passed in as an argument.
More info on this specific pathway will be available in the near future as Sparsify development progresses.

0 comments on commit f85445e

Please sign in to comment.