Cognex Deep Learning Release Notes
Cognex Deep Learning Release Notes
Cognex Deep Learning Release Notes
Release Notes
VisionPro Deep Learning 3.2.1 is a hotfix release of VisionPro Deep Learning 3.2
Enhancements
l The AI Labeling Tool can now be used in the service client environment.
l The AI Labeling Tool now has the undo function.
l The Green Classify High Detail and the Green Classify High Detail Quick tools now also support processing with
images smaller than 64 x 64 pixels.
l The Green Classify High Detail and the Green Classify High Detail Quick tools now also support training only with
images smaller than 64 x 64 pixels.
Note:
l The VisionPro, Designer and VisionPro Deep Learning software require that a valid Cognex Security Dongle be
installed directly to PCs running the software during all phases of operation (programming, processing, training,
testing, etc.). Any attempts to temporarily remove, substitute, or share a Cognex Security Dongle may cause
your system to operate incorrectly, and may result in the loss of data.
When VisionPro Deep Learning is configured for the Client/Server functionality, and a computer has been
configured as a server, the Cognex Security Dongle must be attached to the server, but the client(s) does not
need a Cognex Security Dongle.
l Sample code is included with the VisionPro Deep Learning 3.2.1 installer. The resources for the sample code
(VisionPro Deep Learning 3.2.1 Sample Code Resource.msi), which include images and workspaces, are
available for download from the Cognex Support Site.
l For more information about new API functionality in this release, see the Cognex VisionPro Deep Learning Suite
.NET Library and Cognex VisionPro Deep Learning Suite C API help files.
1
Resolved Issues
Resolved Issues
l Fixed an issue where the 100 x 100 ROI value set by the user was randomized in the ROI setting window.
l Fixed an issue where the VisionPro Deep Learning software was slow when loading the database overview when the
number of classes was eight or more.
l Fixed an issue where the resize size set by the user could not be imported into the Parameter Search in Auto mode.
Previously, the manually set resize size was overwritten by the size calculated by Parameter Search, but now this
does not happen anymore.
l Fixed an issue with the Green Classify High Detail and the Green Classify High Detail Quick tools where the score
was different between the training API and the runtime API. Now both show the same score.
l Fixed an issue with the Green Classify High Detail Quick tool where the marking did not change to label after clearing
a label in a view which had marking and accepting the view.
l Fixed a compatibility issue between VisionPro Deep Learning 3.2.0 and VisionPro 9.20
l Fixed an issue where the Green Classify High Detail mode parameter Validation Set Ratio could not be changed from
20%.
2
Known Issues
Known Issues
The following issues have been identified in this release. For the API known issues, see API Known Issues on page 47
GPU
l Processing Time could be slower compared to 1.0.0 under old GPUs. Processing Time could be slower compared to
1.0.0 when using NVIDIA GeForce® RTX™ 20 series or older series due to NVIDIA internal issues.
l Due to several issues related to GUI and training, all users of VisionPro Deep Learning 3.2.1 MUST use NVIDIA
driver that is of:
o After VisionPro Deep Learning 3.2.1, recommended GPU driver version range is from 528.02 to 532.03, with
the tested version being 528.02. Using driver versions beyond 532.03 may result in slower training and
processing times in High Detail .
Workspace
l Boost::filesystem::rename error occurs when the user or system repetitively saves the workspace in a short time.
This is just an alert that there was an issue while saving. You can solve this problem only by saving the workspace
again.
l Group is shown in the workspace imported from ViDi Suite.
o If you import workspaces including "Group" feature which are made 4.1 and before, "Group" is still displayed
in Cognex Deep Learning Studio 3.0, but you cannot modify this.
o See the FAQ for the workaround for this issue.
o It is recommended to delete "Group" in the previous workspaces and import to Cognex Deep Learning Studio
3.0.
l Especially with bigger than 10GB workspaces,
o Cloning work does not end when you clone tools in different big workspaces at the same time.
o Some images are not included in the created report.
3
Known Issues
Tools - General
l If a tool is not saved well because of unspecific reasons, you cannot export or clone the workspace or the tool. You
can avoid this problem by processing the tools again and save the workspace.
l For all tools, if the tool crashes with some unknown reason, images in this tool are deleted when the workspace that
contains this tool is imported.
l If the name of a set in Database Overview contains a single quote ('), you cannot change the name of this set.
l If the name of a set in Database Overview contains a single quote ('), an error occurs when you try to filter views on
View Browser by clicking the icon of this set in Database Overview.
4
Known Issues
Parameter Search
l In Home page, if you set 1-depth directory path (example: "E:/," or "A:/") in the Path, Parameter Search is terminated
with an error and you can't re-open it. Please refer to Unable to start Parameter Search after setting 1-depth directory
path at Path in its Home page for the workaround of this issue.
GPU
l Processing Time could be slower compared to 1.0.0 under old GPUs. Processing Time could be slower compared to
1.0.0 when using NVIDIA GeForce® RTX™ 20 series or older series due to NVIDIA internal issues.
5
Known Issues
Workspace
l Boost::filesystem::rename error occurs when the user or system repetitively saves the workspace in a short time.
This is just an alert that there was an issue while saving. You can solve this problem only by saving the workspace
again.
l Group is shown in the workspace imported from ViDi Suite.
o If you import workspaces including "Group" feature which are made 4.1 and before, "Group" is still displayed
in Cognex Deep Learning Studio, but you cannot modify this.
o See the FAQ for the workaround for this issue.
o It is recommended to delete "Group" in the previous workspaces and import to Cognex Deep Learning Studio.
l Especially with bigger than 10GB workspaces,
o Cloning work does not end when you clone tools in different big workspaces at the same time.
o Some images are not included in the created report.
Tools - General
l If a tool is not saved well because of unspecific reasons, you cannot export or clone the workspace or the tool. You
can avoid this problem by processing the tools again and save the workspace.
l For all tools, if the tool crashes with some unknown reason, images in this tool are deleted when the workspace that
contains this tool is imported.
l If the name of a set in Database Overview contains a single quote ('), you cannot change the name of this set.
l If the name of a set in Database Overview contains a single quote ('), an error occurs when you try to filter views on
View Browser by clicking the icon of this set in Database Overview.
6
Known Issues
7
Known Issues
Parameter Search
l In Home page, if you set 1-depth directory path (example: "E:/," or "A:/") in the Path, Parameter Search is terminated
with an error and you can't re-open it. Please refer to Unable to start Parameter Search after setting 1-depth directory
path at Path in its Home page for the workaround of this issue.
Plug-in
l For Designer, the added heatmap checkbox is initialized on Deep Learning Runtime Blocks of the tools other than
Red Analyze. Tools other than Red Analyze were supposed not to support heatmap function.
8
Known Issues
GPU
l Processing Time could be slower compared to 1.0.0 under old GPUs. Processing Time could be slower compared to
1.0.0 when using NVIDIA GeForce® RTX™ 20 series or older series due to NVIDIA internal issues.
l Internal issues on supporting NVIDIA driver versions. Due to internal issues related to NVIDIA drivers, all users of
VisionPro Deep Learning 1.1.0 MUST use NVIDIA driver that is of:
o 461.09 or higher version for NVIDIA GeForce® series.
o R460 U2 (461.09) or higher version for NVIDIA RTX / Quadro® series.
l Due to internal issues related to runtime, C API may not work as intended. To prevent this issue, all users of C API
MUST follow the steps below.
1. Remove the currently installed NVIDIA driver from your PC.
2. Reboot your PC and install the DCH NVIDIA driver of which version is compatible with VisionPro Deep
Learning 1.1.0 (461.09 or higher, or R460 U2 (461.09) or higher for NVIDIA RTX / Quadro®)
Workspace
l Boost::filesystem::rename error occurs when the user or system repetitively saves the workspace in a short time.
This is just an alert that there was an issue while saving. You can solve this problem only by saving the workspace
again.
l Group is shown in the workspace imported from ViDi Suite.
o If you import workspaces including "Group" feature which are made 4.1 and before, "Group" is still displayed
in Cognex Deep Learning Studio, but you cannot modify this.
o See the FAQ for the workaround for this issue.
o It is recommended to delete "Group" in the previous workspaces and import to Cognex Deep Learning Studio.
9
Known Issues
Tools - General
l If a tool is not saved well because of unspecific reasons, you cannot export or clone the workspace or the tool. You
can avoid this problem by processing the tools again and save the workspace.
l For all tools, if the tool crashes with some unknown reason, images in this tool are deleted when the workspace that
contains this tool is imported.
l If the name of a set in Database Overview contains a single quote ('), you cannot change the name of this set.
l If the name of a set in Database Overview contains a single quote ('), an error occurs when you try to filter views on
View Browser by clicking the icon of this set in Database Overview.
10
Known Issues
l Erasing maskings/regions in the mask/region editor pane (Edit Mask or Edit Region in right-click popup menu on the
image display area) applies Gaussian smoothing on all the regions/maskings. This causes the entire
maskings/regions to shift slightly and their sizes to be changed slightly. This issue has been an existing issue from
VisionPro ViDi.
11
Known Issues
Plug-in
l For Designer, the added heatmap checkbox is initialized on Deep Learning Runtime Blocks of the tools other than
Red Analyze. Tools other than Red Analyze were supposed not to support heatmap function.
GPU
l Processing Time could be slower compared to 1.0.0 under old GPUs. Processing Time could be slower compared to
1.0.0 when using NVIDIA GeForce® RTX™ 20 series or older series due to NVIDIA internal issues.
l Internal issues on supporting NVIDIA driver versions. Due to internal issues related to NVIDIA drivers, all users of
VisionPro Deep Learning 1.0.1 MUST use NVIDIA driver that is of:
o 457.09 or higher version for NVIDIA GeForce® series.
o R460 U2 (461.09) or higher version for NVIDIA RTX / Quadro® series.
l Due to internal issues related to runtime, C API may not work as intended. To prevent this issue, all users of C API
MUST follow the steps below.
1. Remove the currently installed NVIDIA driver from your PC.
2. Reboot your PC and install the DCH NVIDIA driver of which version is compatible with VisionPro Deep
Learning 1.0.1 (457.09 or higher, or R460 U2 (461.09) or higher for NVIDIA RTX / Quadro®)
l Multiple GPUs are not supported efficiently for High Detail mode. You cannot get an advantage of using multiple
GPUs when you proceed training or processing the other tool specifically with Green Classify Tool in High Detail
mode at the same time. For example, when training or processing job of Focused mode and High Detail mode are
simultaneously being processed, each job could be slower than just training or processing one job at a time.
12
Known Issues
Workspace
l Boost::filesystem::rename error occurs when the user or system repetitively saves the workspace in a short time.
This is just an alert that there was an issue while saving. You can solve this problem only by saving the workspace
again.
l Group is shown in the workspace imported from ViDi Suite.
o If you import workspaces including "Group" feature which are made 4.1 and before, "Group" is still displayed
in Cognex Deep Learning Studio, but you cannot modify this.
o See the FAQ for the workaround for this issue.
o It is recommended to delete "Group" in the previous workspaces and import to Cognex Deep Learning Studio.
l Especially with bigger than 10GB workspaces,
o Cloning work does not end when you clone tools in different big workspaces at the same time.
o Some images are not included in the created report.
Tools - General
l If a tool is not saved well because of unspecific reasons, you cannot export or clone the workspace or the tool. You
can avoid this problem by processing the tools again and save the workspace.
13
Known Issues
14
Migrating to This Release
3.0 → 3.1
Also, importing a Red Analyze High Detail Quick tool trained in an earlier VisionPro Deep Learning version into a VisionPro
Deep Learning 3.2.1 workspace is disabled.
15
Migrating to This Release
When you import a Red Analyze High Detail tool (.vrta) or a Green Classify High Detail tool (.vgta) trained in an earlier
VisionPro Deep Learning version into a VisionPro Deep Learning 3.2.1 workspace:
l The trained network of this tool will be lost.
l The views and their labels of this tool will be preserved.
l The Tool Parameter values will be preserved.
1.1 → 2.0
16
Migrating to This Release
1.0.1 → 1.1
1.0 → 1.0.1
The workspaces created in VisionPro Deep Learning 1.0.0 are fully compatible with VisionPro Deep Learning 1.0.1
17
Migrating to This Release
The Runtime Block includes only one output pin. Individual Tools in the Tool Chain are not visible in the UI. And there are no
preconfigured result pins so you need script for every single application.
Deep Learning Runtime Block does not support an External Fixture.
3.4.1 → 4.1
Note:
This syntax can also more easily be expressed by using the in operator. For example, the following syntax could be
used to simplify the expression:
x in [0,view.width] and y in [0,view.height]
These are used to cycle through the available combinations of display graphics (labels, markings, labels and markings, or no
overlay graphics).
In previous releases, the space bar could be used to show or hide all overlay graphics, but that is no longer supported.
18
Migrating to This Release
For the Blue Locate Tool, a change was made in the behavior of X and Y position clamping when using model matching. In
version 2.1, these constraints were interpreted to apply to the position of the origin of the model coordinates. In version 3.0,
they are interpreted as constraints on the position of the centroid of the nodes in the model.
19
Release History
Release History
This topic lists the features and resolved issues in previous releases of VisionPro Deep Learning.
New Features
l AI labeling tool
In the AI labeling tool, you can use two key tools: AI Click Tool and AI Box Tool. These tools simplify labeling by
automatically recognizing and labeling regions, eliminating the requirement for manual drawing. You can find more
details in the "Create Label" section of Red Analyze.
l Red Analyze processing speed
The processing speed of the Red Analyze was enhanced, particularly in Red Analyze High Detail.
l Faster image addition
Adding images takes reduced time, resulting in faster handling when adding a large number of images.
Enhancements
l GPU Clock Stabilizer
The feature to maintain a stable GPU clock in a deployment environment can be helpful in multi-GPU scenarios or in
situations where clock instability leads to reduced processing speed or spikes. For more details, refer to the API
Change Log or API documentation.
Resolved Issues
l Fixed an issue where CPU memory gradually increased when repeating training and processing of High Detail.
l Fixed an issue where an internal error occurred during the creation of a runtime workspace, preventing its creation
when there was a previously trained model using the large network in theGreen Classify High Detail from versions
prior to VisionPro Deep Learning 3.1.1.
l Fixed an issue where High Detail was not supported in ViDi.ITool.RegionOfInterest.
l Fixed an error when training tools with a 1-channel 16-bit image.
l Fixed an internal error that occurred during the Parameter Search when starting the search for Green Classify High
Detail with Large model.
Resolved Issues
l Fixed an issue where tools trained using Green Classify High Detail tool's "large" modes inVisionPro Deep Learning
3.0 were not processing in VisionPro Deep Learning 3.1.1.
l With the use of CLIP, you can now import a JSON file containing a "bad" tag without regions into Red Analyze.
20
Release History
l Using CLIP, fixed an issue where the region name of a "bad" label in the Red Analyze Focused Supervised appeared
as "bad" instead of "defect" during label export and import.
l Using CLIP, fixed an issue of JSON file format labels not being imported in theGreen Classify.
l The tooltip for the "mode" parameter in the High Detail parameters has been updated.
Resolved Issues
l Fixed an issue in Red Analyze High Detail where the view score would display as 0 after applying a mask and
processing with the API.
l Fixed an issue in the Red Analyze High Detail where the processing results differed when using Whole Image
processing, although differences may still occur within an acceptable margin of error.
l Fixed an issue where out of memory pop-up occurred during processing after completing training with Whole Image
Processing on in Red Analyze High Detail, which prevented saving of the model. The tool now automatically turns off
Whole Image Processing and proceeds with processing if it cannot perform the function.
l Fixed an issue where the application would intermittently crash when loading a runtime workspace with multiple High
Detail and using multi-GPU.
l Fixed an issue where the Reuse mask option was not applied in the ROI settings for downstream tools when Red
Analyze was the preceding tool.
l Fixed an issue where the label check did not run when using Green Classify with more than three tags.
l Restored the pan function that was missing in the image viewer.
l Fixed an issue where Cognex Deep Learning Studio abnormally terminates when clicking on an empty column in the
image list.
l Fixed an issue where Cognex Deep Learning Studio abnormally terminates when entering an invalid color value for
the tag after setting the tag in Green Classify.
l Updated the tooltip description regarding the processing time displayed on the Cognex Deep Learning Studio, as it
was previously shown in view unit instead of image unit.
21
Release History
l Fixed an issue where entering -1 into the command line failed to correctly deactivate the auto-save feature in the
service-client
l Fixed an issue where the C++ sample code, Example.AdaptationMode.HD, was not functioning properly.
l Fixed an issue that caused an error when attempting to switch from Auto mode to Manual mode in Parameter search,
if there were spaces in the tags.
l Fixed an issue where results were not displayed after conducting a search in auto mode with a tool in the downstream
in Parameter search.
22
Release History
o CLIP is a new plug-in that supports importing/exporting masks and labels of a VisionPro Deep Learning
workspace in VisionPro Deep Learning internal and external formats. You can export masks, labels, or
images in a VisionPro Deep Learning workspace in VisionPro Deep Learning internal format or png file
format, and also import masks or labels in various formats into a VisionPro Deep Learning workspace with
this plug-in. See Cognex Label Import/Export Plug-in for details.
l TensorRT Support for Runtime
o The NVIDIA TensorRT is a library that boosts the inference speed of a deep neural network running on
NVIDIA GPUs. The VisionPro Deep Learning now supports TensorRT for the runtime API, boosting the
processing speed of each tool. TensorRT for Runtime is only supported in High Detail tools. For details of
TensorRT support, see API Changelog on page 33.
l Green Classify High Detail Batch Processing Support for Runtime
o Using the Batch Processing API in runtime can speed up the Green Classify High Detail processing via API.
For more details about the batch processing API, see API Changelog on page 33.
l View Browser - List Mode
o The list mode presents an information table that offers much more details about a view's status including
marking, label, sets, or a view's index. You also can star a view if it is an important view or write and edit a
memo for each view. See View Browser - List Mode for details.
l Other Improvements & Changes
o UI/UX Improvements in Parameter Search
o GUI Refinement
o Applying Label Change for Green Classify
o Image Resize for Green Classify High Detail
o Validation Set Indicator and Filter for Validation Set
o Scale Change of Validation Loss
o Image Processing Logic Change for Red Analyze High Detail
o Minimum Image Size Change for Green Classify High Detail
o Training Logic Change with Patience Epochs and Minimum Epochs
o Designer Plug-in Support
o Red Analyze sort filter keyword count(region!) in View Browser which sort the views by the number of
labeled defect regions is changed to count(region![area > 0]).
23
Release History
l Fixed an issue that the processing of Blue Locate or Blue Read rarely gets slower.
o To solve this issue, we allowed access to a new processing parameter called max_scan_iterations in the
runtime API. With this parameter, you can limit the maximum search time to speed up the processing. For
more details, see API Changelog on page 33.
Resolved Issues
l Fixed an issue that the execution of VisionPro 10.1 C# API method Cognex.Vision.Startup.Shutdown() is not
completed within an expected time when using VisionPro Deep Learning Tool Block.
l Fixed an issue that the Focused tools (Blue Locate, Blue Read, Green Classify Focused, Red Analyze Focused
Supervised, Red Analyze Focused Unsupervised) occasionally expose inconsistent results given exactly the same
configurations.
l Fixed an issue that the processing of Blue Locate or Blue Read rarely gets slower. See API Changelog on page 33 for
more details.
Resolved Issues
l Fixed an issue that some runtime API example codes were unable to be run because of missing DLL files.
l Fixed an issue in High Detail Mode tools that the training time keeps increasing when training multiple High Detail
mode tools in sequence.
24
Release History
l Fixed an issue in Parameter Search that searching parameters for a Red Analyze tool already trained in VisionPro
Deep Learning unnecessarily copies existing .vvb files and thus grows the size of the current workspace.
l Fixed an issue in C API that 32-bit images (8-bit, 4 channel) added to a workspace by C API look bizarre when they
are viewed in GUI.
l Fixed an issue in Loss Graph that the Elapsed Time in Status table is not in accordance with the elapsed time in
Progress bar.
l Fixed an issue in Loss Graph that the Elapsed Epoch in Status table and Epoch in the loss graph are displayed
incorrectly.
l Fixed an issue that the value of ViDi2.View.maskCache keeps increasing and consumes memory.
l For High Detail modes, fixed an issue that processing with GPU designation is not available when calling
ISample.Process().
l For VisionPro Deep Learning Client/Server environment, fixed an issue that VisionPro Deep Learning Client/Server
cannot accept "16-bit depth, png/tiff format" image file as its input image.
l For runtime workspaces, fixed an issue that users cannot get the label information of Green Classify High Detail with
Runtime.IGreenTool.KnownTags
l For Red Analyze, fixed an issue that after changing mode of tool operation (Supervised, Unsupervised) the class of a
region is displayed incorrectly.
l For Red Analyze, fixed an issue that after changing mode of tool operation (Supervised, Unsupervised) a region
cannot be modified with Edit Region.
l For Red Analyze High Detail, fixed an issue that if you change the mode of a Red Analyze tool to Red Analyze High
Detail, add images, set ROI, and train with the default tool parameters, the score for a view is not generated.
Resolved Issues
l Fixed an issue that a plug-in that was built in Examples (C:\ProgramData\Cognex\VisionPro Deep
Learning\2.0\Examples\c#\Example.Deep.Learning.Studio.GUI.Plugin) is not shown on Add Plugin window of Plugin
Manager.
25
Release History
l Loss Inspector
o A monitoring tool of the validation loss change during training that guides you in training High Detail Modes
(Red Analyze High Detail and Green Classify High Detail mode).
l F1 Score of Confusion Matrix for Red Analyze tools
o The F1 score of the confusion matrix is introduced to show the result summary of the confusion matrix in Red
Analyze tools. See Red Analyze Focused Supervised - Confusion Matrix for an example of the F1 score of
confusion matrix.
o Unlike the precision, recall, and F-score in Region Area Matrix which are calculated on a "pixel" basis, the F1
score of a confusion matrix is calculated from each "item in the confusion matrix table", aiming to suggest the
performance of this tool with respect to the confusion matrix result.
l Auto Threshold for Red Analyze High Detail and Red Analyze Focused Supervised
o The T1 and T2 threshold values that maximize the F1 score of confusion matrix on Database Overview by
following one of the 4 criteria in the Count dropdown menu. These threshold values are automatically
calculated for you by enabling a checkbox. See Red Analyze Focused Supervised - Neural Network
Processing (Inferencing) for an example of the Auto Threshold.
l Region List for Red Analyze tools
o The region list is introduced to help you find and check the defect regions (both labeled defects and
markings) in a view more easily and conveniently and thus enhance your usability of Red Analyze tools.
l Overlay Checkbox
o For all tools, the overlay checkbox is introduced for a handy alternative to "Cycle through Overlays" in the
right-click pop-up menu on Image Display Area. See Blue Locate - Review Markings for an example of the
overlay checkbox for Blue Locate tool.
l Restore Parameters
o For all tools, the restore parameter button is introduced for an easier "roll-back" of the set of parameter values
in the Tool Parameters pane toward those that were used in the last training session. See Blue Locate -
Neural Network Training for an example of the restore parameters button for Blue Locate tool.
l Wibu CodeMeter Runtime update from 6.70a to 7.20b to resolve the known security vulnerabilities (WIBU-200521-
01, WIBU-200521-02, WIBU-200521-03, WIBU-200521-05, WIBU-200521-06).
26
Release History
Resolved Issues
l Fixed an issue in Parameter Search that some texts in Database Overview are overlapped to each other and
displayed incorrectly.
l Multiple GPUs are now fully supported efficiently for High Detail modes. See Configure Multiple GPUs for the details.
l Fixed a bug that the multiple additions of the same plugin with Manage Plugins.
l Fixed a bug that VisionPro Deep Learning is not launched when the version of nvml.dll
(C:\Windows\System32\nvml.dll) is lower than the NVIDIA graphics driver version.
l Fixed a bug in Blue Read that the overlay of marking and label is not correctly displayed.
l Fixed a bug in Red Analyze that the area under ROC curve is different from AUC value in Database Overview - ROC
tab.
l Fixed an issue in Designer for Red Analyze that the workflow of Deep Learning Runtime Block of Red Analyze slows
down due to heatmap processing. It is fixed by adding a 'heatmap' checkbox and the users now can control the
processing speed by enabling/disabling the checkbox.
l Fixed some naming inconsistencies in C:\ProgramData\Cognex\VisionPro Deep Learning\1.1\Examples\c#
o The assembly name for Example.Training.HDRed.Console is modified to the right name.
o The project file name "Example.ViDi.Suite.GUI.Plugin" is changed to
"Example.Deep.Learning.Studio.GUI.Plugin"
o The assembly name with "space" delimiter is changed to the one with "period/full-stop" delimiter.
Resolved Issues
l Resolved an issue that the prediction result of a cloned Red Analyze Tool is incorrect when Low Precision is enabled.
l Resolved an issue that labeling is mistakenly applied on images, not views, after receiving views from an upstream
tool.
27
Release History
l Resolved an issue that the space between "Image Record" blocks you from using ImageRecord feature with
DeepLearningRuntimeBlock inside Designer.
Resolved Issues
l Resolved an issue with feature size indicator does not change after changing the value of the feature size in the
sampling tool parameter.
l Resolved an issue with "Save new version" in the workspace list does not act in the Blue Read Tool.
l Resolved an issue with name of Set are shown as original name in the image viewer even though users change the
name.
28
Release History
l The ViDi Suite GUI has been localized into six languages: French, German, Japanese, Korean, Simplified Chinese
and Spanish. The language can be selected from the Locale drop-down within the Options dialog.
Resolved Issues
l To improve the ability to determine if a view is labeled or not, a new property, IView.IsLabeled, has been added to the
.NET API.
l Resolved an issue with large images and the Red Analyze tool in Unsupervised mode that could result in an invalid
exception "Database is Locked" error.
29
Release History
Resolved Issues
l Resolved an issue where exporting or cloning a large workspace could cause the ViDi Suite GUI to become
unresponsive or unexpectedly quit.
l Resolved an issue where a Blue Locate or Blue Read tool's graphical display of markings could be offset from its
actual location due to the language settings of the user's PC.
l Resolved an issue with the Blue Read tool's Label Views dialog not displaying the names of Regex models that had
been created.
l Resolved an issue with the Red Analyze tool's generated reports not displaying the markings in the report.
Resolved Issues
Issue Description
AIC- Corrected an issue with NVIDIA drivers 411.31 and newer. For more information, please visit the Cognex Support
1861 Site VisionPro ViDi Software Driver Support page.
AIC- The Set Group option has been restored to the Actions for N Views menu in the View Browser, which allows you to
1801 create a group of images when using the Red Analyze tool in Unsupervised Mode.
AIC- Corrected an issue where a workspace would not function correctly if a stream contained a single quote in the
1201 name.
AIC- Corrected an issue where the ViDi Suite GUI would become unresponsive when applying a region for a Red
1223 Analyze tool with numerous views.
AIC- Corrected an issue where the ViDi Suite GUI would not terminate properly after attempting to connect to a runtime-
1387 only service.
30
Release History
31
Release History
32
API Changelog
API Changelog
This topic lists the API changes in previous releases of VisionPro Deep Learning.
Note:
l This feature is initially disabled by default. You can control its activation or deactivation through the API.
l It should be employed after Compute Device initialization. Attempting to use it before initialization will result in
the C API returning a value other than VIDI_SUCCESS, while the .NET API will trigger an exception.
1 ...
2 /** @brief disable stabilize feature */
3 #define VIDI_STABILIZE_OFF 0
4
5 /** @brief enable stabilize feature on GPUs */
6 #define VIDI_STABILIZE_GPU 1
7
8 /** @brief stabilize the compute devices
9 * @param mode mode of operation
10 * @return 0 if passed, otherwise an error_code that can be
used with vidi_get_error_message()
11 *
12 * @see VIDI_STABILIZE_GPU, VIDI_STABILIZE_OFF
13 * This method must be called after the compute devices have
been initialized.
14 */
15 VIDI_DLLEXPORT VIDI_UINT vidi_stabilize_compute_device(VIDI_
INT mode);
16
17 ///////////////////////////////////////////////////////
33
API Changelog
18 // example
19 ///////////////////////////////////////////////////////
20
21 // Turns on.
22 vidi_stabilize_compute_device(VIDI_STABILIZE_GPU);
23
24 // Turns off
25 vidi_stabilize_compute_device(VIDI_STABILIZE_OFF);
26 ...
1 ...
2 /// <summary>
3 /// Offers the possibility to stabilize the compute
devices when the control is created, without unloading the vidi dll
4 /// example: mode = "StabilizeMode.Off"
5 /// mode = "StabilizeMode.GPU"
6 /// This can only be called after compute devices
initialized.
7 /// </summary>
8 void StabilizeComputeDevices(Enum mode);
9
10
11 ///////////////////////////////////////////////////////
12 // example
13 ///////////////////////////////////////////////////////
14
15 // Turns on
16 control.StabilizeComputeDevices(StabilizeMode.GPU);
17
18 // Turns off
19 control.StabilizeComputeDevices(StabilizeMode.Off);
20 ...
vidi_initialize2() is Deprecated
vidi_initialize2() function has been deprecated.
Starting from version VisionPro Deep Learning 3.2.0, you can load and use both the training API and runtime API
simultaneously. Although the vidi_initialize2() API still exists, it does not perform the intended operation.
34
API Changelog
Deprecated vidi_initialize2()
The steps to use classification batch processing API are summarized as follows.
1. Fix the batch size and prepare the images to process. The maximum batch size is dependent on the current available
GPU memory.
2. Create a sample.
3. Add the prepared images to the sample.
4. Run batch processing.
5. Check the processing results.
For more details of utilizing batch processing API, see the below example codes.
Note: If you select a batch size larger than the maximum batch size which is calculated based on the available memory
of the current GPU in Step 1, the batch processing will fail to start.
C++ Example of Batch Processing API for Runtime (Green High Detail)
1 ...
2 // The maximum batch size depends on the available GPU memory size.
3 // let's suppose the available maximum batch size is 12.
4 constexpr int batch_size = 12;
5
6 // you need to set "runtime_parameters/batch_size" as the batch size you
chose above.
7 // "workspace": the name of your workspace
8 // "default": the name of the stream in your workspace
9 // "Classify": the name of the Green High Detail tool in your stream.
35
API Changelog
...
// The maximum batch size depends on the available GPU memory size.
// let's suppose the available maximum batch size is 12.
int batch_size = 12;
...
36
API Changelog
// you also need to prepare the same number of the images as the batch size
// the paths list should contain the paths of images
List<IImage> imgs = new List<IImage>();
for (int i = 0; i < batch_size; ++i)
imgs.Add(new LibraryImage(paths[i]));
// create a sample for batch processing. Note that a sample is the basic unit of
processing task.
// "Classify": the name of the Green High Detail tool in your stream.
using (IBatchedSample sample = stream.CreateBatchedSample())
{
// add images to sample
for (int i = 0; i < batch_size; ++i)
sample.AddImage(imgs[i]);
// run processing
sample.Process(greenTool);
Note: Batch processing should not be used in a tool chain. If you want to use batch processing in a chain of tools, create
a runtime workspace for each tool and chain them.
37
API Changelog
1. In the training environment, create a workspace, stream, and a High Detail tool. Train the tool to make it ready to be
deployed in the runtime environment. The training environment can be either VisionPro Deep Learning GUI or API.
You can create a workspace, stream, and a High Detail tool and train the tool in GUI. For the more details of the
training and runtime environment, see Environments.
2. Export a runtime workspace which includes the trained High Detail tool. You also can create a runtime workspace in
GUI (Workspace > Export Runtime Workspace). For the more details of the runtime workspace, see Runtime
Workspace.
3. Deploy the runtime workspace and its High Detail tool on the device on your front line. For the more details of the
runtime deployment, see Runtime Workspace and Runtime Deployment.
38
API Changelog
4. Run TensorRT Optimization API to optimize the High Detail tools in your runtime workspace with TensorRT, and save
your runtime workspace. The optimization normally takes under 10 minutes to be completed. After the first run of
optimization, the tool's neural network is optimized to the specific NVIDIA GPU model you use, and from this point,
you can process as many images you want with faster speed.
C++ Example of TensorRT Optimization API for Runtime (Red High Detail and Green High Detail)
1 ...
2 // open the given workspace.
3 // "workspace": the name of your runtime workspace
4 //"..\\..\\resources\\runtime\\Green High-detail Tool.vrws": the path to the
runtime workspace file
5 status = vidi_runtime_open_workspace_from_file("workspace",
"..\\..\\resources\\runtime\\Green High-detail Tool.vrws");
6 ...
7
8 // optimize the High-detail tool
9 // "default": the name of the stream in your workspace
10 // "Classify": the name of the Green High Detail tool in your stream.
11 clog << "Start optimization. It will take a few minutes." << endl;
12 status = vidi_runtime_tool_convert_trt
("workspace", "default", "Classify", 0);
13 ...
14
15 // save runtime workspace with the optimized tool
16 string save_path = "..\\..\\resources\\runtime\\Green High-detail Tool
optimized.vrws";
17 status = vidi_runtime_save_workspace("workspace", save_path.c_str());
18 clog << "The workspace with the optimized tool is saved at " << save_path.c_
str() << endl;
19 ...
C# Example of TensorRT Optimization API for Runtime (Red High Detail and Green High Detail)
1 ...
2 // Open a runtime workspace from file
3 // the path to this file relative to the example root folder
4 // and assumes the resource archive was extracted there.
5 // "workspace": the name of your runtime workspace
6 ViDi2.Runtime.IWorkspace workspace = control.Workspaces.Add("workspace",
"..\\..\\..\\..\\resources\\runtime\\Green High-detail Tool.vrws");
7
39
API Changelog
If you want to use the Classification Batch Processing for Runtime API on page 35 together with TensorRT-optimized
processing, you need to set batch size before calling the optimization.
C++ Example of Setting Batch Size Before Calling TensorRT Optimization (Green High Detail)
C# Example of Setting Batch Size Before Calling TensorRT Optimization (Green High Detail)
40
API Changelog
41
API Changelog
5. Load your runtime workspace in your application and deploy it on the device to process images with the TensorRT-
optimized tool. To do this, you need to set a parameter before processing.
C++ Example of Setting Parameter to Use TensorRT Optimized-model for Processing (Red High Detail
and Green High Detail)
1 // If you want to process with optimized tool, you have to set ProcessTensorRT
to true.
2 // Setting this option to true will trigger TensorRT processing.
3 status = vidi_runtime_tool_set_parameter
("workspace", "default", "Analyze", "runtime_parameters/process_with_
trt", "true");
4 ...
5 status = vidi_runtime_sample_process("workspace", "default", "Analyze", "my_
sample", "");
C# Example of Setting Parameter to Use TensorRT Optimized-model for Processing (Red High Detail
and Green High Detail)
See the example codes below to process images with a runtime workspace.
42
API Changelog
Note: The features or the character features can be less detected than expected when the value of max_scan_
iterations is set too low. The appropriate value for this parameter is dependent on the images.
Examples
This topic introduces the code examples of max_scan_iterations parameter for C and .NET API
C API
.NET API
43
API Changelog
To train Green Classify High Detail Quick, the parameter path should be set to "green_quick" for vidi_training_set_
parameter.
To configure the Tool Parameters for Green Classify High Detail Quick, the parameter path also should be set. For example,
if you want to change Epoch Count in Training Parameters, set the parameter path as:
l workspaces/WORKSPACE_NAME/streams/STREAM_NAME/tools/TOOL_NAME/training_parameters/count_
epochs
1 ...
2 // Green high-detail-quick mode
3 hdGreenTool.Database.Tool.Type = ToolType.GreenQuickHighDetail;
4 ...
5
44
API Changelog
To train Green Classify High Detail Quick, the ViDi2.Training.ITool.Type should be set to
ToolType.GreenQuickHighDetail.
To configure the Tool Parameters for Green Classify High Detail Quick, the
ViDi2.Training.IGreenHighDetailParameters should be set. For example, you should set the value of
CountEpochs for IGreenHighDetailParameters.
See C:\ProgramData\Cognex\VisionPro Deep Learning\2.1\Examples\c#\Example.Training.HDGreen.Console\Program.cs
for the more detailed examples of training .NET API codes.
1 ...
2 // Red high-detail quick mode
3 param_ss << "workspaces/" << workspace_name << "/streams/" << stream_name
<< "/tools/" << tool_name << "/tool_type";
4 status = vidi_training_set_parameter(param_ss.str().c_str(), "red_quick");
5 ...
6
To train Red Analyze High Detail Quick, the parameter path should be set to "red_quick" for vidi_training_set_
parameter.
45
API Changelog
To configure the Tool Parameters for Red Analyze High Detail Quick, the parameter path also should be set. For example, if
you want to change Epoch Count in Training Parameters, set the parameter path as:
l workspaces/WORKSPACE_NAME/streams/STREAM_NAME/tools/TOOL_NAME/training_parameters/count_
epochs
1 ...
2 // Red high-detail quick mode
3 hdRedTool.Database.Tool.Type = ToolType.RedQuickHighDetail;
4 ...
To train Red Analyze High Detail Quick, the ViDi2.Training.ITool.Type should be set to
ToolType.RedQuickHighDetail.
To configure the Tool Parameters for Red Analyze High Detail Quick, the
ViDi2.Training.IRedHighDetailParameters should be set. For example, you should set the value of
CountEpochs for IRedHighDetailParameters.
See C:\ProgramData\Cognex\VisionPro Deep Learning\2.1\Examples\c#\Example.Training.HDRed.Console\Program.cs for
the more detailed examples of training .NET API codes.
46
API Known Issues
47
API Known Issues
48
API Deprecated Features
49
API Deprecated Features
50
API Deprecated Features
51
Documentation Updates
Documentation Updates
VisionPro Deep Learning 3.1
l Added "{}" to the example JSON file in the Cognex Label Import/Export Plug-in page.
52
Documentation Updates
53
Documentation Updates
54
Documentation Updates
l Updates on C#, C++ example codes (...\ProgramData\Cognex\VisionPro Deep Learning\2.1\Examples\). There were
many improvements in example codes and some of the notable changes are:
o The unit of angle for input is changed from "degree" to "radian" (example: Perturbation of Red Analyze)
o For Green Classify, the codes that load label information per image is added.
o The parameter path used for vidi_runtime_get_parameter() and vidi_runtime_set_parameter() is changed to
be a "full path" which should include "tool/" within it.
Example: "workspaces/(workspace_name)/streams/(stream_name)/tools/(tool_
name)/tool/processing/sampling_density"
Note: You can access the latest VisionPro Deep Learning Help on the Cognex Support website:
https://support.cognex.com/en/documentation/deep-learning
55
Preparation
Preparation
This topic covers the computer operating systems, hardware requirements, dongle configuration, licenses, and legal notices
you need to be prepared with before using VisionPro Deep Learning for your application.
Note: The use of the VisionPro Deep Learning software or the Deep Learning Service on a virtual machine (VM) is not
supported.
Note: Due to the issues from the NVIDIA driver, Windows Server 2016 is not supported for VisionPro Deep
Learning3.2.1 Server/Client mode. See Known Issues on page 3 for more details and the workaround.
l CPU
We recommend the higher specification than Intel Core i7. When selecting a CPU, a higher CPU clock speed rate
and multiple core processors will result in faster runtime tool execution. If your application will be relying on the Blue
Locate tool, it is more sensitive to clock speed rates, particularly with complex model matching applications.
l GPU
When selecting a GPU, Cognex only supports NVIDIA GPUs.
For training, we recommend GPUs that have 10GB or larger GPU Memory (1080 Ti, 2080 Ti, 3080). For the
processing of High Detail modes and High Detail Quick modes, GPUs that have 8GB or larger GPU Memory are
recommended.
l System Memory (RAM)
First, 32GB or more than 32GB is recommended.
When selecting the system RAM, specify the greater of:
o The sum of all GPU memory. For example, if you have four NVIDIA GeForce® RTX™ 3080 Ti GPUs, which
each have 10 GB of memory, the PC should have 40 GB of RAM.
o The RAM should be one and a half times the typical workspace size. For example, if your typical workspace is
20 GB, the PC should have a minimum of 30 GB of RAM.
Note: You should have more than 50GB to train the tool with 15,000 images of 1K X 1K.
56
Preparation
l System Storage
Cognex recommends the use of a solid-state drive (SSD), we recommend 100GB + as a free space.
l Power Supply
When selecting your power supply, include a 25% margin above the requirement to accommodate the system and
GPU power requirements, in other words, select a power supply that is 1.25 times the system and GPU power
requirements.
l USB 2.0
USB port for a permanent Cognex Security Dongle (containing the training license) connection via USB 2.0.
Note:
The VisionPro, Designer and VisionPro Deep Learning software require that a valid Cognex Security Dongle be
installed directly to PCs running the software during all phases of operation (programming, processing, training,
testing, etc.). Any attempts to temporarily remove, substitute, or share a Cognex Security Dongle may cause
your system to operate incorrectly, and may result in the loss of data.
Note: When VisionPro Deep Learning is configured for the Client/Server functionality, and a computer has been
configured as a server, the Cognex Security Dongle must be attached to the server, but the client(s) does not
need a Cognex Security Dongle.
l CPU
We recommend the higher specification than Intel Core i7. When selecting a CPU, a higher CPU clock speed rate
and multiple core processors will result in faster runtime tool execution. If your application will be relying on the Blue
Locate tool, it is more sensitive to clock speed rates, particularly with complex model matching applications.
For High Detail modes and High Detail Quick, if you have only CPU; not GPU, you cannot process the tool.
If a single core performs multi-tasks, processing may be jumped up. Therefore, it is necessary to use a sufficient
amount of resources or allocate the single task to a single core.
57
Preparation
l GPU
When selecting a GPU for processing, VisionPro Deep Learning3.2.1 only supports NVIDIA GPUs. Consider the
following when choosing an NVIDIA GPU:
At a minimum, an NVIDIA® CUDA® enabled GPU is required.
When selecting an NVIDIA GPU, a unit with a higher core clock frequency, CUDA cores and Tensor cores will result
in faster computational speeds. Due to this, Cognex strongly recommends the use of NVIDIA RTX / Quadro® and
Tesla GPUs for the following reasons:
o These GPUs support the compute-optimized Tesla Compute Cluster (TCC) mode.
o These GPUs are designed and tested for continuous duty-cycle operation.
o These GPUs undergo rigorous testing and qualification by NVIDIA.
Note:
The VisionPro, Designer and VisionPro Deep Learning software require that a valid Cognex Security Dongle be
installed directly to PCs running the software during all phases of operation (programming, processing, training,
testing, etc.). Any attempts to temporarily remove, substitute, or share a Cognex Security Dongle may cause
your system to operate incorrectly, and may result in the loss of data.
When VisionPro Deep Learning is configured for the Client/Server functionality, and a computer has been
configured as a server, the Cognex Security Dongle must be attached to the server, but the client(s) does not
need a Cognex Security Dongle.
58
Preparation
VisionPro Deep Learning3.2.1 aims to support the most common GPU families, but it’s not practical to test every model or
driver. The table below indicates those models we have explicitly tested and confirmed work, as well as those few models
and families that do not work. Most other common NVIDIA GPUs other than very new models have been used successfully
by customers, even if they haven’t been explicitly tested. In addition, we share specifications for minimum GPU capability, as
well as recommendations high performance GPUs for demanding applications, such as those using Green Classify High
Detail or Red Analyze High Detail.
59
Preparation
Note:
l When selecting a GPU, Cognex only supports NVIDIA GPUs.
l VisionPro Deep Learning3.2.1 supports the use of any NVIDIA CUDA® enabled GPU that provides a compute
capability of 3.0 and higher, and requires a driver version greater than or equal to 528.02.
l CUDA compute capability 5.0 or higher is required to use the core VisionPro Deep Learning functionality. The
Low Precision parameter requires CUDA compute capability 6.1 or higher (for more information, visit the
NVIDIA website).
l When training and processing High Detail mode and High Detail Quick mode, a requirement of 8 GB of GPU
memory is for runtime operation, and 10 GB of GPU memory is recommended for training.
l The NVIDIA GeForce Titan V, NVIDIA RTX / Quadro® GV100 and Tesla V100 include NVIDIA Tensor Cores.
VisionPro Deep Learning3.2.1 will automatically utilize Tensor Cores if they are present, provided you have a
Standard or Advanced security license. Please contact your Cognex Sales Representative for information
about enabling the functionality on your Cognex Security Dongle.
Note: For more information about the VisionPro Deep Learning API, please refer to the Cognex Deep Learning .NET
Documentation and the Cognex Deep Learning C Documentation help files.
60
Preparation
Before Importing into VisionPro Deep Learning After Importing into VisionPro Deep Learning
Tip: As the number and the size of images are getting larger, the training and processing time for all images increases
as well.
61
Preparation
1. Attach the Cognex Security Dongle to a USB port on the computer that will be used to develop the vision application.
2. Download the CognexVisionPro Deep Learning installer from the Cognex support page.
3. Run the VisionPro Deep Learning installer and follow the prompts.
Note:
Choosing the Custom option will allow you to install selected features:
l The Wibu Runtime Server, which is needed to connect to the USB Cognex Security Dongle.
l The main VisionPro Deep Learning application (this is required).
l The VisionPro Deep Learning Developer API.
l The VisionPro, Designer and VisionPro Deep Learning software require that a valid Cognex Security Dongle be
installed directly to PCs running the software during all phases of operation (programming, processing, training,
testing, etc.). Any attempts to temporarily remove, substitute, or share a Cognex Security Dongle may cause
your system to operate incorrectly, and may result in the loss of data.
When VisionPro Deep Learning is configured for the Client/Server functionality, and a computer has been
configured as a server, the Cognex Security Dongle must be attached to the server, but the client(s) does not
need a Cognex Security Dongle.
At the Starting Cognex Deep Learning screen, press the Options button.
62
Preparation
Command Settings
GPU Mode Specifies the GPU mode to be used by the application.
SingleDevicePerTool A single GPU is used for training and processing an image.
MultipleDevicesPerTool MultipleDevicesPerTool that aimed to provide processing an image on multiple
devices has no longer been supported since VisionPro Deep Learning 1.0.0.
NoSupport Specifies that a GPU will not be used.
Optimized Specifies the size of the pre-allocated optimized memory buffer. This setting is activated by default, with the
GPU default size of 2GB.
Memory
Tip: Compute Devices
You can set Optimized GPU Memory in the Help > Compute Devices option.
1. Available Devices
This shows the GPUs that are used for VisionPro Deep Learning. You can check list of multiple
devices and GRAM information here.
2. Optimized GPU Memory
You can enable/disable GPU memory optimization for the use of Focused mode tools. See
NVIDIA GPU Selection and Configuration for the details.
Auto Save Specifies how often a workspace will be auto-saved. The default is every 5 minutes.
Interval
Training Specifies a cache location for training images. This is useful if the images in a stream are in non-raster format
Image (for example JPG, PNG, or GIF), since they must be converted to a raster (BMP) format for training. By
Cache Path default, this conversion happens multiple times for each image. By enabling the Training Image Cache Path,
the conversion is only performed once and the converted images are stored in a local cache directory. The
cache directory should be local, and preferably on a Solid-State Drive (SSD).
This option can also speed up training in cases where the workspace is stored on a slower drive or a remote
storage device.
Locale Specifies the language to use throughout the VisionPro Deep Learning GUI.
Debug Specifies whether or not debug logs should be activated for the project.
Logging
CognexVisionPro Support
VisionPro Deep Learning is qualified to support the following CognexVisionPro release:
l VisionPro9.20
l VisionPro 9.8
For more information about the integration with CognexVisionPro, see Integration with Cognex VisionPro.
63
Legal Notices
Legal Notices
The software described in this document is furnished under license, and may be used or copied only in accordance with the
terms of such license and with the inclusion of the copyright notice shown on this page. Neither the software, this document,
nor any copies thereof may be provided to, or otherwise made available to, anyone other than the licensee. Title to, and
ownership of, this software remains with Cognex Corporation or its licensor. Cognex Corporation assumes no responsibility
for the use or reliability of its software on equipment that is not supplied by Cognex Corporation. Cognex Corporation makes
no warranties, either express or implied, regarding the described software, its merchantability, non-infringement or its fitness
for any particular purpose.
The information in this document is subject to change without notice and should not be construed as a commitment by
Cognex Corporation. Cognex Corporation is not responsible for any errors that may be present in either this document or the
associated software.
Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, nor transferred to any
other media or language without the written permission of Cognex Corporation.
Copyright © 2024. Cognex Corporation. All Rights Reserved.
Portions of the hardware and software provided by Cognex may be covered by one or more U.S. and foreign patents, as well
as pending U.S. and foreign patents listed on the Cognex web site at: cognex.com/patents.
Other product and company trademarks identified herein are the trademarks of their respective owners.
64