Skip to main content

Creating and managing a project

A Project is a set of data (documents or pages with various annotations used for training and evaluation) and models (a system that you train on the training data to make the predictions on other documents or pages not seen before).

Create a new Project

  1. Click the Create a new Project panel on the H2O Document AI - Publisher homepage

Create a new Project button

  1. Enter the name of your project
  2. Toggle whether to auto-purge your training artifacts
  3. Toggle whether to schedule the deletion of your project along with its resources
  4. (Optional) Add a description for your project
  5. Input any collaborators you want to work with on this project (if none, then leave empty)
  6. Upload the desired documents, images, or compressed files
  7. Click Create project

You will find your newly created project under Projects on the left navigation bar. You will also see the artifact uploaded under the Documents sets and Annotation sets sections on your Project home page.

info

Depending upon the size of the uploaded file, it might take some time to populate the Documents sets and Annotation sets sections with the number of documents and the number of pages. You can check the status of the upload by looking at the Status column on the Document sets, Annotation sets, or Jobs pages. A job that is running is pending or processing. A finished job is done or ready.

You can also check the status of a project by opening the background processes tab. You access this by clicking the bell icon next to your account name.

Auto-purge

Automatically purge your training artifacts. Set this option when creating or editing your project. This feature is enabled by your system administrator. The retention period is set by your system administrator, too.

Scheduled deletion

Schedule the deletion of your whole project and all of its resources. By toggling on this feature while creating or editing your project, you can set the date you want to erase your project.

Project collaboration

You can invite other users (collaborators) to work on your project by providing their email addresses in the edit projects panel. Manage your collaborators when creating your project or through selecting Edit Project from the upper navigation bar.

The creator of the project is the owner and ownership cannot be changed. Only the owner has the ability to add or remove collaborators and the ability to open the Edit Project panel. Except for these owner-exclusive privileges, collaborators have the same privileges as the project owner (such as working with document and annotation sets and publishing pipelines).

The UI manages collaborators using a picker component and the role binding is made exclusively through email. The UI validates the existence of the email to your organization (however, it won't autocomplete). An invalid email will prompt an error response.

Project panels

The project panels show overviews of each page. You can access each page by clicking See All on this panel or by accessing it via the left navigation bar.

Document sets

See the most recent updates and scroll through older ones. Select "See All" to access the Document sets page.

Document Sets project panel. Shows available document sets and their statuses. Can access by clicking the See All button in the top right corner of the panel.

Annotation sets

See the most recent updates and scroll through older ones. Select "See All" to access the Annotation sets page.

Annotation Sets project panel. Shows available annotation sets and their statuses. Can access by clicking the See All button in the top right corner of the panel.

Models

See the most recent updates and scroll through older ones. Select "See All" to access the Models page.

Models project panel. Shows available models and their statuses. Can access by clicking the See All button in the top right corner of the panel.

Jobs

See the most recent updates and scroll through older ones. Select "See All" to access the Jobs page.

Jobs project panel. Shows available jobs and their statuses. Can access by clicking the See All button in the top right corner of the panel.

Project jobs

Interact with your project from the upper navigation bar.

Delete project

Delete your project. You will be prompted to acknowledge that the act of deletion is destructive and irreversible.

Delete Project

Export Project images

Export all or selected images from your project. Exporting lets you work with annotation sets offline.

  1. Choose which annotation set images to export by clicking the box next to their names
  2. Click Export

When the job is finished running, the images will be downloaded to your local computer.

Import Post Processor

Import a custom Post Processor.

  1. Provide a name for your post processor
  2. (Optional) Provide a description of your post processor
  3. Drag and drop the zipped post processor directory or browse your local files
  4. Click Import

Import Model

Import a previously built model that you have saved to your local computer.

  1. Provide a name for your imported model
  2. (Optional) Provide a description for your model
  3. Drag and drop the file or browse your local files for the zipped model file
  4. Click Import

Import Annotation set

Import a JSON file of a previously annotated annotation set that you have saved to your local computer.

  1. Provide a name for the imported annotation set
  2. (Optional) Provide a description for your annotation set
  3. Drag and drop the JSON file or browse your local files for the file you want to import
  4. Click Import

Import Document set

This will import a set of documents.

  1. Provide a name for the document set
  2. (Optional) Provide a description for your document set
  3. Select if you want to copy the attributes from an available attribute set
  4. Upload the desired documents, images, or compressed files. You can either drag and drop the zip file or browse for it

Once the document is imported, it will appear in the Document sets page and an entry will appear in the Annotation sets page.


Feedback