When planning your upgrade, you should be aware of how the upgrade will affect your Hyperscience experience, along with any issues you may encounter during the upgrade process.
Before upgrading, we encourage you to review the sections below, followed by our Upgrade Best Practices.
Supported versions
We release new versions of Hyperscience several times a year. We support the three most recent versions of Hyperscience, so we recommend updating regularly to maintain support and take advantage of our latest features.
Upgrading sequentially
When upgrading across multiple versions (e.g., v37 to v41), you cannot skip versions because the application needs all flows and blocks from previous versions to exist. Even if you don’t want to use a given application version, you still need to unpack its bundle. Unpacking a version’s bundle allows our post-migration steps to run.
Compatibility across versions
Some aspects of your current Hyperscience configuration may not be compatible with your target upgrade version.
Component | Compatibility |
|---|---|
Trainer | Use the version that was bundled with your application version |
Layouts and releases | Can be used in the version they were created in and in all subsequent versions |
Flows | Can be used in the version they were created in (X), plus the two immediately after it (X+1 and X+2) |
Models |
|
Submissions | Can be processed in the version they were created in (X), plus the two immediately after it (X+1 and X+2) |
To learn more about compatibility across versions, see the sections below.
Trainer
Trainers aren’t upgraded; they’re overwritten. For ease of use, you can install the new trainer version on the same machine where the previous trainer version is installed.
To learn more about installing the trainer, see Technical Installation / Upgrade Instructions.
You cannot install a trainer on the machine where the Hyperscience application is installed.
Layouts and releases
Layouts and releases are compatible with all future versions. After upgrading the application, all layouts and releases you had on your previous version continue to function as intended.
After upgrading, layouts and releases preserve their respective statuses:
Layout statuses:
Live
Not Live
Release statuses:
Live
Locked
Draft
Flows
Flows can be used in the application version they were created in, the version directly after it, and the version directly after that version. The use of flows in any other subsequent application versions is not supported. For example, flows created in v39 can be used in v40 and v41. Hyperscience will not support the use of those flows in v42, v43, etc.
Models
Model compatibility across versions differs by model type:
Field Identification, Table Identification, and Classification models — You can use any model with any flow, as long as they were both created in the current version of the application, the previous version, or the version preceding that version.
Transcription and Text Classification models — The versions of these models must match their flow versions.
Training models
Depending on which version your models were created in and which version you’re upgrading to, you may need to retrain your models during the upgrade process. See our version-specific upgrade instructions for guidance on your upgrade path.
We recommend allowing the new trainer to run training jobs for at least 2-3 days. You may benefit from allowing even more time for training, depending on the number of eligible training documents available. Only submissions that have not yet had their PII deleted can be used to train the models. Contact your Hyperscience representative to determine how long to train the models on the new trainer before upgrading the application.
Unless otherwise noted, you do not need to retrain models when upgrading to a patch version (e.g., v41.0.4 to v41.0.5) or a minor version (e.g., v41.1.0 to v41.2.0).
Submissions
Because submissions are ingested or uploaded into flows, their version compatibility is the same as those flows. Therefore, submissions that are created before an upgrade are compatible with the next two versions. For example, submissions that are created in a v39 flow are compatible with v40 and v41. If you are upgrading to v41 and still have submissions that were created in v38, you have to resubmit these submissions, complete (a.k.a “drain”) them, or delete them before upgrading. To learn more about how to drain submissions, see the “Draining submissions” content in our version-specific upgrade articles:
Upgrading to v40 (with submissions being created during the upgrade process)
Upgrading to v40 (without submissions being created during the upgrade process)
Upgrading to v41 (with submissions being created during the upgrade process)
Upgrading to v41 (without submissions being created during the upgrade process)