Mirrors
/
EveryDream2trainer
mirror of https://github.com/victorchall/EveryDream2trainer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs

This commit is contained in:
Victor Hall 2023-04-02 21:43:46 -04:00
parent 246fb4fa00
commit 0b629436c5
2 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/CONTRIBUTING.md
View File

@ -30,12 +30,14 @@ The most important thing to do when contributing is to make sure to *run trainin
**If you cannot test every possible platform, your contribution is still welcome.** Please note waht you can and did test in your PR and we can work together to ensure it works across platforms, either by analysis for trivial changes, or help with testing. Some changes are small isolated and may not require full testing across all platforms, but noting how you tested will help us ensure it works for everyone. **If you cannot test every possible platform, your contribution is still welcome.** Please note waht you can and did test in your PR and we can work together to ensure it works across platforms, either by analysis for trivial changes, or help with testing. Some changes are small isolated and may not require full testing across all platforms, but noting how you tested will help us ensure it works for everyone.
**WIP** *link to a test data set will go here* **WIP**
## Code style and linting ## Code style and linting
**WIP** (there's a .pylint at least...) **WIP** (there's a .pylint at least...)
### Running tests
**WIP** There is a small suite of automated unit tests. **WIP**
## Documentation ## Documentation
Please update the appropriate document file in `/doc` for your changes. If you are adding a new feature, please add a new section for users to read in order to understand how to use it, or if it is a significant feature, add a new document and link it from the main README.md or from the appropriate existing document. Please update the appropriate document file in `/doc` for your changes. If you are adding a new feature, please add a new section for users to read in order to understand how to use it, or if it is a significant feature, add a new document and link it from the main README.md or from the appropriate existing document.
@ -54,6 +56,4 @@ There is no formation process for contributing to EveryDream, but please conside
* Please consider checking in on the Discord #help channel after release to spot possible bugs encountered by users after your PR is merged. * Please consider checking in on the Discord #help channel after release to spot possible bugs encountered by users after your PR is merged.
### Running tests
**WIP** There is a small suite of automated unit tests. **WIP**

3
train.json
View File

@ -1,5 +1,4 @@
{ {
"amp": true,
"batch_size": 10, "batch_size": 10,
"ckpt_every_n_minutes": null, "ckpt_every_n_minutes": null,
"clip_grad_norm": null, "clip_grad_norm": null,
@ -35,7 +34,7 @@
"scale_lr": false, "scale_lr": false,
"seed": 555, "seed": 555,
"shuffle_tags": false, "shuffle_tags": false,
"validation_config": null, "validation_config": "validation_default.json",
"wandb": false, "wandb": false,
"write_schedule": false, "write_schedule": false,
"rated_dataset": false, "rated_dataset": false,