Interact with Platform

Introduction

The View Platform Projects window allows you to create and manage Platform projects based on your Studio project.

To view the window if you are not connected to the Platform:

• Connect to the Platform application and select View Platform Projects at the end of the procedure.

Or, if you are connected to the Platform:

• Select View Platform Projects on the main toolbar.

Or:

• Select Studio > View Platform Projects on the main menu.

Manage projects

Sort projects

To change the sort order of projects, select a column heading. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Create a new Platform project

To create a Platform project based on your Studio project module:

1. Select Publish to new Platform project on the project list toolbar.
2. Type the project name under Name.

3. Select the technology version under Tech Version.

   Note

   The NL Core version is also reported with the technology version.

4. Select the project type from the Type of project drop-down menu.

5. Type an optional description under Description
6. Select Create.

You can see the operation progress:

• Through the progress bar in the lower right corner of the Studio main window.

Or:

• Under the Status column of the new project row.

  Note

  A gear icon indicates the operation progress.

Info

If your Studio project performs both extraction and categorization, you may need to create two Platform projects, a categorization project and an extraction project.

The new Platform project will contain:

• In the case of a categorization project, the Studio project taxonomy and a generic library containing a "Welcome to Studio" sample document.
• In the case of an extraction project, classes corresponding to Studio project templates and fields and a generic library containing a "Welcome to Studio" sample document.

Create and delete links

A link between your Studio project module and a Platform project, represented by the chain icon under the Linked column, is automatically created when you create a new Platform project from your Studio project module.

• To manually link a Platform project to your Studio project module, select the Platform project from the list, then select Link Module on the project list toolbar.
• To delete an existing link between your Studio project module and a Platform project, select the linked Platform project from the list, then select Delete Platform Link on the project list toolbar.

Info

Linked projects that have been deleted in Platform continue to be listed, with an "open chain" icon under the Linked column, in the Platform Projects window until you delete the link. You can't delete a Platform project from Studio.

To delete a link from the Project tool window:

1. Right-click in the tool window and select Platform Action > Unlink from Platform project.
2. Select Unlink.

Filter projects

To filter projects according to their type, select the type from the Type drop-down menu on the project list toolbar. Possible choices are:

• All to show all types of projects identified by the "C" and "E" icons .
• Categorization to show only categorization projects, identified by the "C" icon under the Type column.
• Extraction to show only extraction projects, identified by the "E" icon under the Type column.

Open Platform projects

To open a linked Platform project, select the project, then select Open Platform project on the project list toolbar.

To open any project, double-click anywhere on the project row.

Refresh the list of projects

To refresh the list of Platform projects, select Refresh List on the project list toolbar.

View Platform project information

To show information about a linked Platform project, select View Platform Project Info . The Project on Platform window will appear.

Manage libraries

Sort libraries

To change the sort order of project libraries, select a column heading of the Libraries tab. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Upload a Studio library to a Platform project

To upload a Studio library to a Platform project:

1. Select the Platform project, then select Upload Studio library on the Libraries tab toolbar.

2. In the Studio Libraries dialog select an existing library.

   Or:

   1. Select Create Studio library .
   2. Proceed as for importing a library.
   3. When done, the new library is listed in Studio Libraries: select it.

   The Studio Libraries dialog lists Studio project module libraries in a table with the following columns:

   Name	Description
   File	Library name
   Description	Library description
   Project	Project name
   Module	Module name
   Language	Language
   Creation Date	Creation date and time
   File Size	Library size
   Test Files	Number of documents
   Annotated Files	Number of annotated documents

   Select the column headers to change the sort order.

3. Select Upload.

4. Type a name for the Platform project library and select Yes.

You can see the operation progress:

• Through the progress bar in the lower right corner of the Studio main window.

Or:

• Under the Status column.

  Note

  A gear icon indicates the operation progress.

The Platform library type will be "generic", so neither "training" nor "test".

To upload a library from the Project:

1. Right-click the .zip file and select Platform Actions > Upload Studio library. The Upload Library dialog will appear.
2. Select the module associated to your profile name in the Platform Project drop-down menu.
3. Give the library a name and select Upload. The upload will occur as a background task. At the end of the task, a notification will warn you.

All annotations found in the Studio library will be re-created in the Platform library.
Folders with more than 30000 files will be skipped and files greater than 500 KB will be ignored during Platform analyses.

Download a library from a Platform project

To download a library from a Platform project:

1. Select a Platform project then select one of its libraries.
2. Select Download Platform library on the Libraries tab toolbar.
3. In the dialog, type a name or accept the suggested one.
4. When documents are uploaded, the text that is analyzed and indexed can undergo changes such as merging consecutive spaces. To export texts with their original spacing, check Include original text spaced documents.

5. Select:

   • All documents to download the entire library.

   Or:

   • Filtered documents to download the filtered document list based on annotated documents.

You can see the operation progress in the lower right corner of the Studio main window or in the Status column of the Libraries tab.
In the notification in the lower right corner, select Import Library to proceed with the library import.

Note

Once you select Import Library, you will be at the step 3 of the import procedure described in the dedicated page.

Refresh the list of libraries

To refresh the list of libraries for a Platform project, select the project from the list then select Refresh List on the Libraries tab toolbar.

Start an experiment on Platform

To start an experiment on Platform, using one of the project's CPKs:

1. Select a Platform project then select Experiment on Platform on the project list toolbar.
2. In the dialog, type an optional name for the Platform experiment corresponding to the analysis, then select a library and a CPK from the drop-down menus. If no CPK is available or if you want to create a CPK based on the latest changes to your Studio project module, select <Update Platform Project> from the Model drop-down menu.
3. Select Start.

You can see the operation progress in the lower right corner of the Studio main window.
Inside the notification in the lower right corner of the main Studio window, select View on Platform to open experiment results inside Platform.

According to the experiment type—performed either on Studio or on Platform—the Type column will show these icons:

Icon	Name	Description
	Studio Model	Experiment based on a Studio CPK (both for categorization and extraction)
	Explainable Model	Experiment based on explainable model types (both for categorization and extraction)
	Bootstrapped Model	Experiment based on a simplified version of the Explainable Categorization engine

Models

Sort models

To change the sort order of project models, select a column heading of the Models tab. The first selection causes sorting on the values of the selected column, each further selection reverses the sorting order, from ascending to descending and vice versa.

Upload a model

To upload a model corresponding to the current module of the Studio project into a Platform project:

1. Select the target Platform project.

2. In the Models tab, select Update Platform project . The Studio cpk dialog will appear.

   Note

   The operation will occur as a background task. You can perform this task even without deploying your project first.

3. Select one of the available modules in the list and select Upload.

   Or:

   Select Deploy new package to deploy your current Studio project module and follow the upload procedure.

   Note

   Within this dialog, you can:

   • Sort models by selecting the column names.
   • Refresh the model list by selecting Refresh List .

4. After selecting Upload, a notification will appear. Select Yes. The model for the current module of the Studio project is built and then uploaded to the selected Platform project as a new model.

You can see the operation progress:

• In the lower right corner of the Studio main window.

Or:

• Under the Status column.

  Note

  A gear icon indicates the operation progress.

To upload the model from the Project tool window:

1. Right-click in the Project tool window and select Platform Actions > Upload Studio cpk.
2. In the dialog, select Upload. The upload occurs as a background task.

Note

You can see the task progress in the lower right corner of the Studio main window.

Download a model

To download a model from a Platform project and create a new Studio project out of it:

1. Select the Platform project.
2. Select the model then select Download Knowledge Model .

You can see the operation progress in the lower right corner of the Studio main window.
The model file will be downloaded in a sub-folder of the operating system temporary folder.
Inside the notification in the lower right corner of the main Studio window, select Create new Project to create a new Studio project out of the CPK.

Refresh the list of models

To refresh the list of models for a Platform project, select the project from the list, then select Refresh List in the Models tab toolbar.