Deep learning project. More...
Public Member Functions | |
| None | __init__ (self, str projectFile) |
| Creates or opens a project. | |
| None | __init__ (self, str projectDir, str projectName, eVision.EasyDeepLearning.EDeepLearningToolType type) |
| Creates or opens a project. | |
| None | __init__ (self) |
| Creates or opens a project. | |
| None | __init__ (self, eVision.EasyDeepLearning.EDeepLearningProject other) |
| Creates or opens a project. | |
| None | CopyTo (self, eVision.EasyDeepLearning.EDeepLearningProject other) |
| Copy the project. | |
| None | SaveProject (self) |
| Saves an opened project. | |
| None | Save (self, str projectFile) |
| Saves a project and set the project directory to the parent directory of projectFile. | |
| None | Save (self, eVision.ESerializer|None serializer) |
| Saves a project and set the project directory to the parent directory of projectFile. | |
| None | Load (self, str projectFile) |
| Loads a project. | |
| None | Load (self, eVision.ESerializer|None serializer) |
| Loads a project. | |
| None | CloseSerializer (self) |
| Closes the internal serializer and unlocks the project files and directory. | |
| bool | HasFileStructureUpdates (self) |
| Whether the project can be updated to a new folder and file structure. | |
| None | UpdateProjectFileStructure (self) |
| Updates the project file structure. | |
| None | UnsetGoodLabel (self) |
| Remove the good label for EasySegment Unsupervised. | |
| eVision.EasyDeepLearning.EDeepLearningTool|None | GetToolCopy (self, int toolId, bool includeTrainingModel) |
| Loads and returns the i-th tool of the project. | |
| eVision.EasyDeepLearning.EDeepLearningTool|None | GetToolCopy (self, int toolId) |
| Loads and returns the i-th tool of the project. | |
| str | GetToolName (self, int toolId) |
| Tool name. | |
| None | SetToolName (self, int toolId, str name) |
| Tool name. | |
| int | GetToolCreationDate (self, int toolId) |
| Creation date of the tool represented as the number of seconds since the UNIX epoch. | |
| str | GetToolISOCreationDate (self, int toolId) |
| Creation date of the tool represented as an ISO 8601 date (YYYY-MM-DD HH:MM:SS). | |
| bool | IsToolNameValid (self, str toolName) |
| Checks that the tool name is valid (not used by any other tool). | |
| None | AddTool (self, str name) |
| Adds a new tool with the given name. | |
| None | RemoveTool (self, int toolId) |
| Removes the given tool from the project. | |
| None | ImportTool (self, str name, str path) |
| Imports an existing tool. | |
| None | ImportTool (self, str name, eVision.EasyDeepLearning.EDeepLearningTool tool) |
| Imports an existing tool. | |
| None | SetToolSplit (self, int toolId, int splitId) |
| Dataset split associated with a tool. | |
| int | GetToolSplit (self, int toolId) |
| Dataset split associated with a tool. | |
| None | SetToolDataAugmentation (self, int toolId, int dataAugmentationId) |
| Data augmentation associated with a tool. | |
| int | GetToolDataAugmentation (self, int toolId) |
| Data augmentation associated with a tool. | |
| int | GetNumBenchmarks (self, int toolId) |
| Number of benchmarks for the given tool. | |
| eVision.EasyDeepLearning.EDeepLearningBenchmark | GetBenchmark (self, int toolId, int benchId) |
| Gets a benchmark for a given tool. | |
| None | AddBenchmark (self, int toolId, eVision.EasyDeepLearning.EDeepLearningBenchmark benchmark) |
| Adds a benchmark for the given tool. | |
| None | RemoveBenchmark (self, int toolId, int benchmarkId) |
| Removes a benchmark. | |
| None | SetBenchmark (self, int toolId, int benchmarkId, eVision.EasyDeepLearning.EDeepLearningBenchmark benchmark) |
| Replaces a benchmark. | |
| None | AddSplit (self, str name, eVision.EasyDeepLearning.EDatasetSplit split) |
| Adds a split. | |
| None | RemoveSplit (self, int splitId) |
| Removes a split. | |
| eVision.EasyDeepLearning.EDatasetSplit | GetSplit (self, int splitId) |
| Gets the dataset split object for the given index. | |
| str | GetSplitName (self, int splitId) |
| Name of the split. | |
| None | SetSplitName (self, int splitId, str newName) |
| Name of the split. | |
| int | GetSplitCreationDate (self, int splitId) |
| Creation date of the split represented as the number of seconds since the UNIX epoch. | |
| str | GetSplitCreationISODate (self, int splitId) |
| Creation date of the split formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS). | |
| eVision.EasyDeepLearning.EDataAugmentation | GetDataAugmentation (self, int dataAugmentationId) |
| Gets the data augmentation object for the given index. | |
| str | GetDataAugmentationName (self, int dataAugmentationId) |
| Name of the data augmentation. | |
| None | SetDataAugmentationName (self, int dataAugmentationId, str name) |
| Name of the data augmentation. | |
| int | GetDataAugmentationCreationDate (self, int dataAugmentationId) |
| Creation date of the data augmentation represented as the number of seconds since the UNIX epoch. | |
| str | GetDataAugmentationCreationISODate (self, int dataAugmentationId) |
| Creation date of the data augmentation formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS). | |
| None | AddDataAugmentation (self, str name) |
| Adds an empty or specified data augmentation to the project. | |
| None | AddDataAugmentation (self, str name, eVision.EasyDeepLearning.EDataAugmentation dataAugmentation) |
| Adds an empty or specified data augmentation to the project. | |
| None | RemoveDataAugmentaton (self, int dataAugmentationId) |
| Removes the given data augmentation. | |
| str | GetResultFilename (self, int imageId) |
| Result filename for the given image. | |
| str | ProjectDirectory (self) |
| Project directory. | |
| ProjectDirectory (self, str value) | |
| Project directory. | |
| str | ProjectFile (self) |
| Path to the project file. | |
| str | ImageDirectory (self) |
| Image directory. | |
| bool | ImportImageIntoProjectDirectory (self) |
| Whether to import the images into the eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory. | |
| ImportImageIntoProjectDirectory (self, bool value) | |
| Whether to import the images into the eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory. | |
| eVision.EasyDeepLearning.EDeepLearningToolType | Type (self) |
| Type of the tools in the projects. | |
| Type (self, eVision.EasyDeepLearning.EDeepLearningToolType value) | |
| Type of the tools in the projects. | |
| str | Name (self) |
| Name of the project. | |
| Name (self, str value) | |
| Name of the project. | |
| int | CreationDate (self) |
| Creation date of the project represented as the number of seconds since the UNIX epoch. | |
| str | ISOCreationDate (self) |
| Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS). | |
| str | FileStructureUpdateDescription (self) |
| Description of the file structure update. | |
| str | GoodLabel (self) |
| Good label for EasySegment Unsupervised. | |
| GoodLabel (self, str value) | |
| Good label for EasySegment Unsupervised. | |
| int | NumTools (self) |
| Number of tools. | |
| int | NumSplits (self) |
| Number of dataset splits in the project. | |
| eVision.EasyDeepLearning.EDataset | Dataset (self) |
| Gets the dataset contained in the project. | |
| int | NumDataAugmentations (self) |
| Number of data augmentation. | |
Static Public Member Functions | |
| eVision.EasyDeepLearning.EDataAugmentation | GetDefaultDataAugmentation (eVision.EasyDeepLearning.EDeepLearningToolType type) |
| Returns the default data augmentation used in Deep Learning Studio depending on the given tool type. | |
Deep learning project.
A deep learning project manages a directory (eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory) in which it stores:
Remarks:
Call to eVision.EasyDeepLearning.EDeepLearningProject.CloseSerializer is mandatory after usage to ensure the file handle used by this class is properly released.
License(s): EasyClassify or EasySegment or EasyLocate
| None eVision.EasyDeepLearning.EDeepLearningProject.__init__ | ( | self, | |
| str | projectFile ) |
Creates or opens a project.
| projectFile | Main project file top open |
| None eVision.EasyDeepLearning.EDeepLearningProject.__init__ | ( | self, | |
| str | projectDir, | ||
| str | projectName, | ||
| eVision.EasyDeepLearning.EDeepLearningToolType | type ) |
Creates or opens a project.
| projectDir | Directory for a new project |
| projectName | Name of the new project project |
| type | Type of the new project |
| None eVision.EasyDeepLearning.EDeepLearningProject.__init__ | ( | self | ) |
Creates or opens a project.
| None eVision.EasyDeepLearning.EDeepLearningProject.__init__ | ( | self, | |
| eVision.EasyDeepLearning.EDeepLearningProject | other ) |
Creates or opens a project.
| other | Other project for the copy constructor |
| None eVision.EasyDeepLearning.EDeepLearningProject.AddBenchmark | ( | self, | |
| int | toolId, | ||
| eVision.EasyDeepLearning.EDeepLearningBenchmark | benchmark ) |
Adds a benchmark for the given tool.
| toolId | Index of the tool |
| benchmark | Benchmark to add to the project |
| None eVision.EasyDeepLearning.EDeepLearningProject.AddDataAugmentation | ( | self, | |
| str | name ) |
Adds an empty or specified data augmentation to the project.
| name | Name for the data augmentation |
| None eVision.EasyDeepLearning.EDeepLearningProject.AddDataAugmentation | ( | self, | |
| str | name, | ||
| eVision.EasyDeepLearning.EDataAugmentation | dataAugmentation ) |
Adds an empty or specified data augmentation to the project.
| name | Name for the data augmentation |
| dataAugmentation | Instance of eVision.EasyDeepLearning.EDataAugmentation class |
| None eVision.EasyDeepLearning.EDeepLearningProject.AddSplit | ( | self, | |
| str | name, | ||
| eVision.EasyDeepLearning.EDatasetSplit | split ) |
Adds a split.
| name | Name of the split |
| split | Instance of eVision.EasyDeepLearning.EDatasetSplit class. |
| None eVision.EasyDeepLearning.EDeepLearningProject.AddTool | ( | self, | |
| str | name ) |
Adds a new tool with the given name.
| name | Name of the tool. |
| None eVision.EasyDeepLearning.EDeepLearningProject.CloseSerializer | ( | self | ) |
Closes the internal serializer and unlocks the project files and directory.
This method is always called implicitly during the destruction of the object. It is still recommended to call it explicitly in programming languages other than C++ to ensure the underlying ressources are correctly released.
This method never throws exceptions.
| None eVision.EasyDeepLearning.EDeepLearningProject.CopyTo | ( | self, | |
| eVision.EasyDeepLearning.EDeepLearningProject | other ) |
Copy the project.
| other | Other project |
| int eVision.EasyDeepLearning.EDeepLearningProject.CreationDate | ( | self | ) |
Creation date of the project represented as the number of seconds since the UNIX epoch.
| eVision.EasyDeepLearning.EDataset eVision.EasyDeepLearning.EDeepLearningProject.Dataset | ( | self | ) |
Gets the dataset contained in the project.
| str eVision.EasyDeepLearning.EDeepLearningProject.FileStructureUpdateDescription | ( | self | ) |
Description of the file structure update.
| eVision.EasyDeepLearning.EDeepLearningBenchmark eVision.EasyDeepLearning.EDeepLearningProject.GetBenchmark | ( | self, | |
| int | toolId, | ||
| int | benchId ) |
Gets a benchmark for a given tool.
| toolId | Index of the tool |
| benchId | Index of the benchmark |
| eVision.EasyDeepLearning.EDataAugmentation eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentation | ( | self, | |
| int | dataAugmentationId ) |
Gets the data augmentation object for the given index.
| dataAugmentationId | Index of the data augmentation |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentationCreationDate | ( | self, | |
| int | dataAugmentationId ) |
Creation date of the data augmentation represented as the number of seconds since the UNIX epoch.
| dataAugmentationId | Index of the data augmentation |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentationCreationISODate | ( | self, | |
| int | dataAugmentationId ) |
Creation date of the data augmentation formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
| dataAugmentationId | Index of the data augmentation |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentationName | ( | self, | |
| int | dataAugmentationId ) |
Name of the data augmentation.
| dataAugmentationId | Index of the data augmentation |
|
static |
Returns the default data augmentation used in Deep Learning Studio depending on the given tool type.
| type | Type of the project |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetNumBenchmarks | ( | self, | |
| int | toolId ) |
Number of benchmarks for the given tool.
| toolId | Index of the tool |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetResultFilename | ( | self, | |
| int | imageId ) |
Result filename for the given image.
| imageId | Index of the image in the dataset |
| eVision.EasyDeepLearning.EDatasetSplit eVision.EasyDeepLearning.EDeepLearningProject.GetSplit | ( | self, | |
| int | splitId ) |
Gets the dataset split object for the given index.
| splitId | Index of the split |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetSplitCreationDate | ( | self, | |
| int | splitId ) |
Creation date of the split represented as the number of seconds since the UNIX epoch.
| splitId | Index of the split |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetSplitCreationISODate | ( | self, | |
| int | splitId ) |
Creation date of the split formatted as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
| splitId | Index of the split |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetSplitName | ( | self, | |
| int | splitId ) |
Name of the split.
| splitId | Index of the split |
| eVision.EasyDeepLearning.EDeepLearningTool | None eVision.EasyDeepLearning.EDeepLearningProject.GetToolCopy | ( | self, | |
| int | toolId ) |
Loads and returns the i-th tool of the project.
The user is responsible for deleting the returned object.
| toolId | Index of the tool |
| eVision.EasyDeepLearning.EDeepLearningTool | None eVision.EasyDeepLearning.EDeepLearningProject.GetToolCopy | ( | self, | |
| int | toolId, | ||
| bool | includeTrainingModel ) |
Loads and returns the i-th tool of the project.
The user is responsible for deleting the returned object.
| toolId | Index of the tool |
| includeTrainingModel | Whether to include the training model |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetToolCreationDate | ( | self, | |
| int | toolId ) |
Creation date of the tool represented as the number of seconds since the UNIX epoch.
| toolId | Index of the tool |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetToolDataAugmentation | ( | self, | |
| int | toolId ) |
Data augmentation associated with a tool.
| toolId | Index of the tool |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetToolISOCreationDate | ( | self, | |
| int | toolId ) |
Creation date of the tool represented as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
| toolId | Index of the tool |
| str eVision.EasyDeepLearning.EDeepLearningProject.GetToolName | ( | self, | |
| int | toolId ) |
Tool name.
| toolId | Index of the tool |
| int eVision.EasyDeepLearning.EDeepLearningProject.GetToolSplit | ( | self, | |
| int | toolId ) |
Dataset split associated with a tool.
| toolId | Index of the tool |
| str eVision.EasyDeepLearning.EDeepLearningProject.GoodLabel | ( | self | ) |
Good label for EasySegment Unsupervised.
| eVision.EasyDeepLearning.EDeepLearningProject.GoodLabel | ( | self, | |
| str | value ) |
Good label for EasySegment Unsupervised.
| bool eVision.EasyDeepLearning.EDeepLearningProject.HasFileStructureUpdates | ( | self | ) |
Whether the project can be updated to a new folder and file structure.
| str eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory | ( | self | ) |
Image directory.
Calling this method will create the image directory if it doesn't exist.
| bool eVision.EasyDeepLearning.EDeepLearningProject.ImportImageIntoProjectDirectory | ( | self | ) |
Whether to import the images into the eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory.
(Default value: true)
Remarks:
This is a hint for Deep Learning Studio and this property will not be enforced when adding images through the API.
Importing the images into the project directory allows relocating a project to another computer.
| eVision.EasyDeepLearning.EDeepLearningProject.ImportImageIntoProjectDirectory | ( | self, | |
| bool | value ) |
Whether to import the images into the eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory.
(Default value: true)
Remarks:
This is a hint for Deep Learning Studio and this property will not be enforced when adding images through the API.
Importing the images into the project directory allows relocating a project to another computer.
| None eVision.EasyDeepLearning.EDeepLearningProject.ImportTool | ( | self, | |
| str | name, | ||
| eVision.EasyDeepLearning.EDeepLearningTool | tool ) |
Imports an existing tool.
Note that the imported tool will be copied into the project directory. The original file will no be used by the project.
The labels' name, weight, and color in the imported tool will be taken from the dataset.
| name | Name for the imported tool. |
| tool | Tool object to import. A copy of the tool will be made internally. |
| None eVision.EasyDeepLearning.EDeepLearningProject.ImportTool | ( | self, | |
| str | name, | ||
| str | path ) |
Imports an existing tool.
Note that the imported tool will be copied into the project directory. The original file will no be used by the project.
The labels' name, weight, and color in the imported tool will be taken from the dataset.
| name | Name for the imported tool. |
| path | Path towards the tool file. |
| str eVision.EasyDeepLearning.EDeepLearningProject.ISOCreationDate | ( | self | ) |
Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).
| bool eVision.EasyDeepLearning.EDeepLearningProject.IsToolNameValid | ( | self, | |
| str | toolName ) |
Checks that the tool name is valid (not used by any other tool).
| toolName | Tool name |
| None eVision.EasyDeepLearning.EDeepLearningProject.Load | ( | self, | |
| eVision.ESerializer | None | serializer ) |
Loads a project.
| serializer | The serializer. This overload will throw as it's an invalid operation. |
| None eVision.EasyDeepLearning.EDeepLearningProject.Load | ( | self, | |
| str | projectFile ) |
Loads a project.
| projectFile | Project file to load. |
| str eVision.EasyDeepLearning.EDeepLearningProject.Name | ( | self | ) |
Name of the project.
| eVision.EasyDeepLearning.EDeepLearningProject.Name | ( | self, | |
| str | value ) |
Name of the project.
| int eVision.EasyDeepLearning.EDeepLearningProject.NumDataAugmentations | ( | self | ) |
Number of data augmentation.
Remarks:
A project always contains an empty data augmentation at index 0.
| int eVision.EasyDeepLearning.EDeepLearningProject.NumSplits | ( | self | ) |
Number of dataset splits in the project.
| int eVision.EasyDeepLearning.EDeepLearningProject.NumTools | ( | self | ) |
Number of tools.
| str eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory | ( | self | ) |
Project directory.
The project directory can only be set on an empty project. Setting the project directory will create the directory if it doesn't exist.
| eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory | ( | self, | |
| str | value ) |
Project directory.
The project directory can only be set on an empty project. Setting the project directory will create the directory if it doesn't exist.
| str eVision.EasyDeepLearning.EDeepLearningProject.ProjectFile | ( | self | ) |
Path to the project file.
The path to the project file is only defined for a project that has non-empty eVision.EasyDeepLearning.EDeepLearningProject.Name and eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory.
| None eVision.EasyDeepLearning.EDeepLearningProject.RemoveBenchmark | ( | self, | |
| int | toolId, | ||
| int | benchmarkId ) |
Removes a benchmark.
| toolId | Index of the tool |
| benchmarkId | Index of the benchmark to remove |
| None eVision.EasyDeepLearning.EDeepLearningProject.RemoveDataAugmentaton | ( | self, | |
| int | dataAugmentationId ) |
Removes the given data augmentation.
The data augmentation at index 0 can't be removed.
| dataAugmentationId | Index of the data augmentation to remove |
| None eVision.EasyDeepLearning.EDeepLearningProject.RemoveSplit | ( | self, | |
| int | splitId ) |
Removes a split.
| splitId | Index of the split |
| None eVision.EasyDeepLearning.EDeepLearningProject.RemoveTool | ( | self, | |
| int | toolId ) |
Removes the given tool from the project.
This will also remove all files and directories associated with the tool (tool directory, result and metrics files).
| toolId | Index of the tool to remove |
| None eVision.EasyDeepLearning.EDeepLearningProject.Save | ( | self, | |
| eVision.ESerializer | None | serializer ) |
Saves a project and set the project directory to the parent directory of projectFile.
| serializer | The serializer. This overload will throw as it's an invalid operation. |
| None eVision.EasyDeepLearning.EDeepLearningProject.Save | ( | self, | |
| str | projectFile ) |
Saves a project and set the project directory to the parent directory of projectFile.
| projectFile | Project file to save. |
| None eVision.EasyDeepLearning.EDeepLearningProject.SaveProject | ( | self | ) |
Saves an opened project.
| None eVision.EasyDeepLearning.EDeepLearningProject.SetBenchmark | ( | self, | |
| int | toolId, | ||
| int | benchmarkId, | ||
| eVision.EasyDeepLearning.EDeepLearningBenchmark | benchmark ) |
Replaces a benchmark.
| toolId | Index of the tool |
| benchmarkId | Index of the benchmark to replace |
| benchmark | New benchmark |
| None eVision.EasyDeepLearning.EDeepLearningProject.SetDataAugmentationName | ( | self, | |
| int | dataAugmentationId, | ||
| str | name ) |
Name of the data augmentation.
| dataAugmentationId | Index of the data augmentation |
| name | New name for the data augmentation |
| None eVision.EasyDeepLearning.EDeepLearningProject.SetSplitName | ( | self, | |
| int | splitId, | ||
| str | newName ) |
Name of the split.
| splitId | Index of the split |
| newName | New name for the split |
| None eVision.EasyDeepLearning.EDeepLearningProject.SetToolDataAugmentation | ( | self, | |
| int | toolId, | ||
| int | dataAugmentationId ) |
Data augmentation associated with a tool.
| toolId | Index of the tool |
| dataAugmentationId | Index of the data augmentation |
| None eVision.EasyDeepLearning.EDeepLearningProject.SetToolName | ( | self, | |
| int | toolId, | ||
| str | name ) |
Tool name.
Changing the name of a tool will move the directory in which the tool is saved.
| toolId | Index of the tool |
| name | New name for the tool |
| None eVision.EasyDeepLearning.EDeepLearningProject.SetToolSplit | ( | self, | |
| int | toolId, | ||
| int | splitId ) |
Dataset split associated with a tool.
| toolId | Index of the tool |
| splitId | Index of the split |
| eVision.EasyDeepLearning.EDeepLearningToolType eVision.EasyDeepLearning.EDeepLearningProject.Type | ( | self | ) |
Type of the tools in the projects.
| eVision.EasyDeepLearning.EDeepLearningProject.Type | ( | self, | |
| eVision.EasyDeepLearning.EDeepLearningToolType | value ) |
Type of the tools in the projects.
| None eVision.EasyDeepLearning.EDeepLearningProject.UnsetGoodLabel | ( | self | ) |
Remove the good label for EasySegment Unsupervised.
| None eVision.EasyDeepLearning.EDeepLearningProject.UpdateProjectFileStructure | ( | self | ) |
Updates the project file structure.