Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update the engine anatomy to under development

Browse Source
This commit is contained in:
Arista Indrajaya 2024-03-13 15:57:52 +07:00
parent 6017ab1fd8
commit 5663d3176b
1 changed files with 3 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/developer/03-build-engine/02-engine-anatomy.md
View File

@ -17,16 +17,6 @@ keywords:
]
---
![plugin-diagram](./asset/plugin.png)
The diagram above illustrates the class hierarchy and interface implementation for an extension. The plugin that you have created has two important aspects:
- `BaseExtension`
- `InferenceInterface`
### BaseExtension
This class acts as a base that defines the properties and methods for your engine. These methods include:
- `type`: Defines the type of the extension.
- `onLoad`: A method that will be called when the extension is loaded or registered into the Jan application.
- `onUnload`: A method for cleanup tasks when the extension is being removed or unloaded from the Jan application.
### InferenceInterface
This interface defines the methods that must be provided to implement your engine's interface.
- `inference(req) -> resp`: A method responsible for handling inference operations. It takes a request `req` as input and returns a response `resp`. This method's implementation should contain the logic for processing input data and producing an inference result.
:::caution
This is currently under development.
:::