10.1.2

Edit

Configure project

To configure an AutoML SDK project, use one of the following methods:

Use AutoML SDK Wizard

AutoML SDK Wizard is the simplest way to configure a new AutoML SDK project in WorkFusion Studio. Follow the instructions below to quickly get started with a new project:

  1. In WorkFusion Studio, click File > New > AutoML SDK Project.

  2. Select the Archetype Catalog:

    • Remote. For an on-premise installation, specify a URL to a pre-installed Nexus repository with all artifacts. For training purposes, specify the WorkFusion Maven repository. Enter your username and password.

    • Local. Specify the path to the archetype-catalog.xml file.

  3. Select the way you want your project to be created:

    • Create an empty project if you want to have an empty model without any configuration.

    • Extend generic models if you want your model to have a generic model configuration.

  4. Select values for Type of ML Project and AutoML SDK Version.

  5. Specify the properties and parameters for your AutoML SDK project. Note that the parameters are predefined.

    • groupId: group identifier of your artifact
    • artifactId: unique identifier of your artifact
    • version: artifact version
    • package: default package for code generation
    • modelClassName: model's class name
    • modelCode: hyper model code; only [a-z, 0-9, _, -] allowed
    • modelDescription: hyper model description to be used as a hint during automation setup in WorkFusionas
    • modelTitle: hyper model title to be used as a drop-down value during automation setup in WorkFusion
    • modelVersion: hyper model version

  6. Click Finish and wait till your project is set up.

Now you're ready to start using the AutoML SDK project.

Use WorkFusion Studio

Set up project

  1. In WorkFusion Studio, click Window > Preferences > Maven > Archetypes.
  2. Click Add Remote Catalog.... You can choose the pre-installed Nexus repository with all artifacts for an on-premise installation or the WorkFusion Maven repository for training purposes.
  3. Provide a URL to the repository, add the repository description (optional), and click OK.
  4. Click OK to save the changes.

Generate project from Archetype

  1. In WorkFusion Studio, click File > New > Other > Maven.
  2. Select Maven Project, and click Next.
  3. Select Use default Workspace location, and click Next.
  4. Select the Catalog you created in the previous section, select an Archetype for your use case (Information Extraction or Classification), and click Next.
  5. Specify the Archetype parameters:
    • groupId: group identifier of your artifact
    • artifactId: unique identifier of your artifact
    • version: artifact version
    • package: default package for code generation
    • importConfigurationFromGenericModel: y for a generic model configuration or n for an empty model without any configuration
    • modelClassName: class name of your model
    • modelCode: hyper model code; only [a-z, 0-9, _, -] allowed
    • modelDescription: hyper model description to be used as a hint during automation setup in WorkFusion
    • modelTitle: hyper model title to be used as a drop-down value in the automation setup in WorkFusion
    • modelVersion: hyper model version
  6. Click Finish to generate a new project with the specified values.
  7. In Project tree, right-click the pom.xml file.
  8. Click Run As > Maven install and wait for the project to be built.

As soon as you see the BUILD SUCCESS message in the console, you are ready to use your custom model.

Use command line

Choose proper Maven command

To generate a stub using the command line, choose one of the following Maven commands, depending on the model type and Search Engine version.

Search Engine 2.0 models

  • Information Extraction

    mvn archetype:generate -DarchetypeGroupId=com.workfusion.ml -DarchetypeArtifactId=ml-sdk-ie-se-20-archetype -DarchetypeVersion=<%artifact-version%>

  • Classification

    mvn archetype:generate -DarchetypeGroupId=com.workfusion.ml -DarchetypeArtifactId=ml-sdk-classification-se-20-archetype -DarchetypeVersion=<%artifact-version%>

  • Binary Classification

    mvn archetype:generate -DarchetypeGroupId=com.workfusion.ml -DarchetypeArtifactId=ml-sdk-binary-classification-se-20-archetype -DarchetypeVersion=<%artifact-version%>

Generate project

  1. Copy one of the above-mentioned commands.
  2. Replace <%artifact-version%> with the current version of your AutoML SDK (for example, 10.0.x.x).
  3. Add the following fields:
    • groupId: group identifier of your artifact
    • artifactId: unique identifier of your artifact
    • version: artifact version
    • package: default package for code generation
    • importConfigurationFromGenericModel: y for a generic model configuration or n for an empty model without any configuration
    • modelClassName: class name of your model
    • modelCode: hyper model code; only [a-z, 0-9, _, -] allowed
    • modelDescription: hyper model description to be used as a hint during automation setup in WorkFusion
    • modelTitle: hyper model title to be used as a drop-down value during automation setup in WorkFusion
    • modelVersion: hyper model version

Your hyper model stub is generated. It's a Maven project you can import to your preferred Java IDE.

The generated stub has the following structure:

example-ie
├── src
│   ├── main
│   │   └── java
│   │   │    └── com
│   │   │        └── wf
│   │   │            └── example
│   │   │                ├── example_ie
│   │   │                │   ├── config
│   │   │                │   │   └── ExampleIeModelConfiguration.java
│   │   │                │   ├── model
│   │   │                │   │   └── ExampleIeModel.java
│   │   │                │   └── run
│   │   │                │       ├── ModelProcessingRunner.java
│   │   │                │       └── ModelTrainingRunner.java
│   │   │                └── FeatureExtractorExample.java
│   │   │                └── PostProcessorExample.java
│   │   └── resources
│   │       └── logback-local.xml
│   └── test
│       ├── java
│       └── resources
└── target
    └── pom.xml

Check project artifacts

The generated stub can contain the following classes:

  • <%artifact-name%>Model class with a custom hyper model

    In the class, you can find a basic configuration of your hyper model: code, version, title, and so on. It also contains the generated ModelConfiguration annotation with a pre-generated model configuration. The generated hyper model extends one of the generic models: GenericIeHyperModel for IE models and GenericMultiClassificationHyperModel for Classification ones.

  • <%artifact-name%>Configuration class with your model configuration

    It has methods, such as processor, featureExtractors, annotators, where you can define your model configuration.

  • PostProcessorExample: Post-Processor example

  • FeatureExtractorExample: Feature Extractor example

  • ModelTrainingRunner: class for a local model training run

  • ModelProcessingRunner: class for a local model execution run to develop or debug post-processing

← Configure local environmentCreate AutoML SDK configuration →