Interface ArtifactExports

The type for artifact plugin export. As a pipcook artifact plugin, we need to export two function named initialize and build.

Hierarchy

ArtifactExports

Index

Methods

Methods

build

build(modelDir: string, options: Record<string, any>): Promise<void>

- Defined in packages/core/src/artifact.ts:30
After the model being trained successfully, the function build will be called with the model directory and options.

Parameters
- modelDir: string
- options: Record<string, any>
  
  the options for the plugin
Returns Promise<void>

initialize

initialize(options: Record<string, any>): Promise<void>

- Defined in packages/core/src/artifact.ts:23
initialize is called before the pipeline starting, plugin can do initialization here, something like environment checking, login to the server, etc. The options are defined in the pipeline metadata, like:
```
{
  artifacts:[{
    processor: 'server-uploader',
    options: {
      targetUrl: 'http://os.alibaba.com/pipcook/model/'
    }
  }]
}
```
Parameters
- options: Record<string, any>
  
  the options for the plugin
Returns Promise<void>

Generated using TypeDoc