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

Merge pull request #238 from reijerh/patch-1 

Quick edits to improve PLUGINS.md
This commit is contained in:
Victor Hall 2023-11-13 13:41:10 -05:00 committed by GitHub
parent 0b843718b8 a53f19a048
commit b63ae0dafd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/PLUGINS.md
View File

@ -2,20 +2,23 @@
This is a very early and evolving feature, but users who have a need to extend behavior can now do so with plugin loading. This is a very early and evolving feature, but users who have a need to extend behavior can now do so with plugin loading.
## Plugin creation
To create a plugin, extend the BasePlugin class and override the methods you want to change. To create a plugin, extend the BasePlugin class and override the methods you want to change.
For example, lets say we made ExampleLoggingPlugin class, and placed it in a file called `plugins/example_plugin.py`: For example, let's say we made the `ExampleLoggingPlugin` class, and placed it in a file called `plugins/example_plugin.py`:
To activate a plugin, edit your `train.json` as follows:
To activate a plugin, edit your `train.json` and use
```"plugins": ["plugins.example_plugin.ExampleLoggingPlugin"],``` ```"plugins": ["plugins.example_plugin.ExampleLoggingPlugin"],```
This uses module-path-like to your class. For this example, `plugins/example_plug.py` contains a class `ExampleLoggingPlugin` which extends `BasePlugin`. You can go look at the [example](plugins/example_plugin.py) to see how this one works. The entries are in 'module-path-like' form to your class. For this example, `plugins/example_plugin.py` contains a class `ExampleLoggingPlugin` which extends `BasePlugin`. See this [example](../plugins/example_plugin.py) for more details.
Everything is passed in as kwargs and the list of variables passed in is not fully defined yet. Consider it an open question what should be passed in, but it should be specific to the context, such as on_epoch_start should not pass in batch data or anything specific to step except for `epoch` and `global_step`. You can add as many plugins as you want, and each plugin only needs to implement the functions you wish.
You can pass in as many plugins as you want, and each plugin only needs to implement the functions you wish. Data is passed to the plugin functions as a list of variables via `kwargs`, but it's still an open question which data should be passed in. In any case it should be relevant to the function, e.g. `on_epoch_start()` should not receive batch data or anything specific to a step, except for `epoch` and `global_step`.
## Quick example
A basic implementation of a plugin that only uses the "end of an epoch" function will look something like this: A basic implementation of a plugin that only uses the "end of an epoch" function will look something like this:
@ -25,4 +28,4 @@ from plugins.plugins import BasePlugin
class MyPlugin(BasePlugin): class MyPlugin(BasePlugin):
def on_epoch_end(self, **kwargs): def on_epoch_end(self, **kwargs):
print(f"hello world, this is a plugin at the end of epoch number: {kwargs['epoch']}") print(f"hello world, this is a plugin at the end of epoch number: {kwargs['epoch']}")
``` ```