Fix Readmes #46
Merged
Fix Readmes #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samet-akcay
reviewed
Dec 22, 2021
samet-akcay
reviewed
Dec 22, 2021
samet-akcay
reviewed
Dec 22, 2021
| python tools/train.py # Train PADIM on MVTec leather | ||
| ``` | ||
|
|
||
| Training a model on a specific dataset and category requires further configuration. Each model has its own configuration | ||
| file, [`config.yaml`](https://gitlab-icv.inn.intel.com/algo_rnd_team/anomaly/-/blob/development/stfpm/anomalib/models/stfpm/config.yaml) | ||
| , which contains data, model and training configurable parameters. To train a specific model on a specific dataset and | ||
| category, the config file is to be provided: | ||
| ``` | ||
|
|
||
| ```bash | ||
| python tools/train.py --model_config_path <path/to/model/config.yaml> |
There was a problem hiding this comment.
python tools/train.py --model_config_path anomalib/models/stfpm/config.yaml
There was a problem hiding this comment.
To show that we have some sample configs for each algo
samet-akcay
reviewed
Dec 22, 2021
samet-akcay
reviewed
Dec 22, 2021
samet-akcay
requested changes
Dec 22, 2021
There was a problem hiding this comment.
Thanks @ashwinvaidya17! What an improvement! Only minor stuff on the main readme file. It's based on personal experience. When I first try a repo, I just copy paste the example code to see if it works. If not, I got annoyed easily :D
djdameln
reviewed
Dec 22, 2021
…kit/anomalib into refactor/ashwin/fix_readmes
samet-akcay
approved these changes
Dec 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Possible Issues
I have explained the models based on my understanding. Might be wrong. It would be nice to look into that first.