eVision.EasyDeepLearning.EDeepLearningProject Class Reference

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.

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.

Protected Member Functions
str	_ProjectDirectory__getter (self)
	\cond
	_ProjectDirectory__setter (self, str value)
	Project directory.
str	_ProjectFile__getter (self)
	\cond
str	_ImageDirectory__getter (self)
	\cond
bool	_ImportImageIntoProjectDirectory__getter (self)
	\cond
	_ImportImageIntoProjectDirectory__setter (self, bool value)
	Whether to import the images into the eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory.
eVision.EasyDeepLearning.EDeepLearningToolType	_Type__getter (self)
	\cond
	_Type__setter (self, eVision.EasyDeepLearning.EDeepLearningToolType value)
	Type of the tools in the projects.
str	_Name__getter (self)
	\cond
	_Name__setter (self, str value)
	Name of the project.
int	_CreationDate__getter (self)
	\cond
str	_ISOCreationDate__getter (self)
	\cond
str	_FileStructureUpdateDescription__getter (self)
	\cond
str	_GoodLabel__getter (self)
	\cond
	_GoodLabel__setter (self, str value)
	Good label for EasySegment Unsupervised.
int	_NumTools__getter (self)
	\cond
int	_NumSplits__getter (self)
	\cond
eVision.EasyDeepLearning.EDataset	_Dataset__getter (self)
	\cond
int	_NumDataAugmentations__getter (self)
	\cond

Properties
	ProjectDirectory = property(_ProjectDirectory__getter, _ProjectDirectory__setter)
	\endcond
	ProjectFile = property(_ProjectFile__getter, None)
	\endcond
	ImageDirectory = property(_ImageDirectory__getter, None)
	\endcond
	ImportImageIntoProjectDirectory = property(_ImportImageIntoProjectDirectory__getter, _ImportImageIntoProjectDirectory__setter)
	\endcond
	Type = property(_Type__getter, _Type__setter)
	\endcond
	Name = property(_Name__getter, _Name__setter)
	\endcond
	CreationDate = property(_CreationDate__getter, None)
	\endcond
	ISOCreationDate = property(_ISOCreationDate__getter, None)
	\endcond
	FileStructureUpdateDescription = property(_FileStructureUpdateDescription__getter, None)
	\endcond
	GoodLabel = property(_GoodLabel__getter, _GoodLabel__setter)
	\endcond
	NumTools = property(_NumTools__getter, None)
	\endcond
	NumSplits = property(_NumSplits__getter, None)
	\endcond
	Dataset = property(_Dataset__getter, None)
	\endcond
	NumDataAugmentations = property(_NumDataAugmentations__getter, None)
	\endcond

Detailed Description

Deep learning project.

A deep learning project manages a directory (eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory) in which it stores:

• A main project file (eVision.EasyDeepLearning.EDeepLearningProject.ProjectFile) containing the dataset, the dataset splits, data augmentation objects, and meta data about the tools;
• A image directory to store the images of the dataset (eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory);
• A directory for each tool named after the corresponding tool name (eVision.EasyDeepLearning.EDeepLearningProject.GetToolName).

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

Constructor & Destructor Documentation

__init__() [1/4]

None eVision.EasyDeepLearning.EDeepLearningProject.__init__	(		self,
		str	projectFile )

Creates or opens a project.

Parameters

projectFile

Main project file top open

__init__() [2/4]

None eVision.EasyDeepLearning.EDeepLearningProject.__init__	(		self,
		str	projectDir,
		str	projectName,
		eVision.EasyDeepLearning.EDeepLearningToolType	type )

Creates or opens a project.

Parameters

projectDir	Directory for a new project
projectName	Name of the new project project
type	Type of the new project

__init__() [3/4]

None eVision.EasyDeepLearning.EDeepLearningProject.__init__

(

self

)

Creates or opens a project.

__init__() [4/4]

None eVision.EasyDeepLearning.EDeepLearningProject.__init__	(		self,
		eVision.EasyDeepLearning.EDeepLearningProject	other )

Creates or opens a project.

Parameters

other

Other project for the copy constructor

Member Function Documentation

_CreationDate__getter()

int eVision.EasyDeepLearning.EDeepLearningProject._CreationDate__getter ( self )

protected

\cond

Creation date of the project represented as the number of seconds since the UNIX epoch.

_Dataset__getter()

eVision.EasyDeepLearning.EDataset eVision.EasyDeepLearning.EDeepLearningProject._Dataset__getter ( self )

protected

\cond

Gets the dataset contained in the project.

_FileStructureUpdateDescription__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._FileStructureUpdateDescription__getter ( self )

protected

\cond

Description of the file structure update.

_GoodLabel__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._GoodLabel__getter ( self )

protected

\cond

Good label for EasySegment Unsupervised.

_GoodLabel__setter()

eVision.EasyDeepLearning.EDeepLearningProject._GoodLabel__setter ( self, str value )

protected

Good label for EasySegment Unsupervised.

_ImageDirectory__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._ImageDirectory__getter ( self )

protected

\cond

Image directory.

Calling this method will create the image directory if it doesn't exist.

_ImportImageIntoProjectDirectory__getter()

bool eVision.EasyDeepLearning.EDeepLearningProject._ImportImageIntoProjectDirectory__getter ( self )

protected

\cond

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.

_ImportImageIntoProjectDirectory__setter()

eVision.EasyDeepLearning.EDeepLearningProject._ImportImageIntoProjectDirectory__setter ( self, bool value )

protected

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.

_ISOCreationDate__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._ISOCreationDate__getter ( self )

protected

\cond

Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

_Name__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._Name__getter ( self )

protected

\cond

Name of the project.

_Name__setter()

eVision.EasyDeepLearning.EDeepLearningProject._Name__setter ( self, str value )

protected

Name of the project.

_NumDataAugmentations__getter()

int eVision.EasyDeepLearning.EDeepLearningProject._NumDataAugmentations__getter ( self )

protected

\cond

Number of data augmentation.

Remarks:

A project always contains an empty data augmentation at index 0.

_NumSplits__getter()

int eVision.EasyDeepLearning.EDeepLearningProject._NumSplits__getter ( self )

protected

\cond

Number of dataset splits in the project.

_NumTools__getter()

int eVision.EasyDeepLearning.EDeepLearningProject._NumTools__getter ( self )

protected

\cond

Number of tools.

_ProjectDirectory__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._ProjectDirectory__getter ( self )

protected

\cond

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.

_ProjectDirectory__setter()

eVision.EasyDeepLearning.EDeepLearningProject._ProjectDirectory__setter ( self, str value )

protected

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.

_ProjectFile__getter()

str eVision.EasyDeepLearning.EDeepLearningProject._ProjectFile__getter ( self )

protected

\cond

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.

_Type__getter()

eVision.EasyDeepLearning.EDeepLearningToolType eVision.EasyDeepLearning.EDeepLearningProject._Type__getter ( self )

protected

\cond

Type of the tools in the projects.

_Type__setter()

eVision.EasyDeepLearning.EDeepLearningProject._Type__setter ( self, eVision.EasyDeepLearning.EDeepLearningToolType value )

protected

Type of the tools in the projects.

AddBenchmark()

None eVision.EasyDeepLearning.EDeepLearningProject.AddBenchmark	(		self,
		int	toolId,
		eVision.EasyDeepLearning.EDeepLearningBenchmark	benchmark )

Adds a benchmark for the given tool.

Parameters

toolId	Index of the tool
benchmark	Benchmark to add to the project

AddDataAugmentation() [1/2]

None eVision.EasyDeepLearning.EDeepLearningProject.AddDataAugmentation	(		self,
		str	name )

Adds an empty or specified data augmentation to the project.

Parameters

name	Name for the data augmentation

AddDataAugmentation() [2/2]

None eVision.EasyDeepLearning.EDeepLearningProject.AddDataAugmentation	(		self,
		str	name,
		eVision.EasyDeepLearning.EDataAugmentation	dataAugmentation )

Adds an empty or specified data augmentation to the project.

Parameters

name	Name for the data augmentation
dataAugmentation	Instance of eVision.EasyDeepLearning.EDataAugmentation class

AddSplit()

None eVision.EasyDeepLearning.EDeepLearningProject.AddSplit	(		self,
		str	name,
		eVision.EasyDeepLearning.EDatasetSplit	split )

Adds a split.

Parameters

name	Name of the split
split	Instance of eVision.EasyDeepLearning.EDatasetSplit class.

AddTool()

None eVision.EasyDeepLearning.EDeepLearningProject.AddTool	(		self,
		str	name )

Adds a new tool with the given name.

Parameters

name	Name of the tool.

CloseSerializer()

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.

CopyTo()

None eVision.EasyDeepLearning.EDeepLearningProject.CopyTo	(		self,
		eVision.EasyDeepLearning.EDeepLearningProject	other )

Copy the project.

Parameters

other

Other project

GetBenchmark()

eVision.EasyDeepLearning.EDeepLearningBenchmark eVision.EasyDeepLearning.EDeepLearningProject.GetBenchmark	(		self,
		int	toolId,
		int	benchId )

Gets a benchmark for a given tool.

Parameters

toolId	Index of the tool
benchId	Index of the benchmark

GetDataAugmentation()

eVision.EasyDeepLearning.EDataAugmentation eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentation	(		self,
		int	dataAugmentationId )

Gets the data augmentation object for the given index.

Parameters

dataAugmentationId

Index of the data augmentation

GetDataAugmentationCreationDate()

int eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentationCreationDate	(		self,
		int	dataAugmentationId )

Creation date of the data augmentation represented as the number of seconds since the UNIX epoch.

Parameters

dataAugmentationId

Index of the data augmentation

GetDataAugmentationCreationISODate()

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).

Parameters

dataAugmentationId

Index of the data augmentation

GetDataAugmentationName()

str eVision.EasyDeepLearning.EDeepLearningProject.GetDataAugmentationName	(		self,
		int	dataAugmentationId )

Name of the data augmentation.

Parameters

dataAugmentationId

Index of the data augmentation

GetDefaultDataAugmentation()

eVision.EasyDeepLearning.EDataAugmentation eVision.EasyDeepLearning.EDeepLearningProject.GetDefaultDataAugmentation ( eVision.EasyDeepLearning.EDeepLearningToolType type )

static

Returns the default data augmentation used in Deep Learning Studio depending on the given tool type.

Parameters

type	Type of the project

GetNumBenchmarks()

int eVision.EasyDeepLearning.EDeepLearningProject.GetNumBenchmarks	(		self,
		int	toolId )

Number of benchmarks for the given tool.

Parameters

toolId

Index of the tool

GetResultFilename()

str eVision.EasyDeepLearning.EDeepLearningProject.GetResultFilename	(		self,
		int	imageId )

Result filename for the given image.

Parameters

imageId

Index of the image in the dataset

GetSplit()

eVision.EasyDeepLearning.EDatasetSplit eVision.EasyDeepLearning.EDeepLearningProject.GetSplit	(		self,
		int	splitId )

Gets the dataset split object for the given index.

Parameters

splitId

Index of the split

GetSplitCreationDate()

int eVision.EasyDeepLearning.EDeepLearningProject.GetSplitCreationDate	(		self,
		int	splitId )

Creation date of the split represented as the number of seconds since the UNIX epoch.

Parameters

splitId

Index of the split

GetSplitCreationISODate()

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).

Parameters

splitId

Index of the split

GetSplitName()

str eVision.EasyDeepLearning.EDeepLearningProject.GetSplitName	(		self,
		int	splitId )

Name of the split.

Parameters

splitId

Index of the split

GetToolCopy() [1/2]

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.

Parameters

toolId

Index of the tool

GetToolCopy() [2/2]

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.

Parameters

toolId	Index of the tool
includeTrainingModel	Whether to include the training model

GetToolCreationDate()

int eVision.EasyDeepLearning.EDeepLearningProject.GetToolCreationDate	(		self,
		int	toolId )

Creation date of the tool represented as the number of seconds since the UNIX epoch.

Parameters

toolId

Index of the tool

GetToolDataAugmentation()

int eVision.EasyDeepLearning.EDeepLearningProject.GetToolDataAugmentation	(		self,
		int	toolId )

Data augmentation associated with a tool.

Parameters

toolId

Index of the tool

GetToolISOCreationDate()

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).

Parameters

toolId

Index of the tool

GetToolName()

str eVision.EasyDeepLearning.EDeepLearningProject.GetToolName	(		self,
		int	toolId )

Tool name.

Parameters

toolId

Index of the tool

GetToolSplit()

int eVision.EasyDeepLearning.EDeepLearningProject.GetToolSplit	(		self,
		int	toolId )

Dataset split associated with a tool.

Parameters

toolId

Index of the tool

HasFileStructureUpdates()

bool eVision.EasyDeepLearning.EDeepLearningProject.HasFileStructureUpdates

(

self

)

Whether the project can be updated to a new folder and file structure.

ImportTool() [1/2]

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.

Parameters

name	Name for the imported tool.
tool	Tool object to import. A copy of the tool will be made internally.

ImportTool() [2/2]

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.

Parameters

name	Name for the imported tool.
path	Path towards the tool file.

IsToolNameValid()

bool eVision.EasyDeepLearning.EDeepLearningProject.IsToolNameValid	(		self,
		str	toolName )

Checks that the tool name is valid (not used by any other tool).

Parameters

toolName

Tool name

Load() [1/2]

None eVision.EasyDeepLearning.EDeepLearningProject.Load	(		self,
		eVision.ESerializer | None	serializer )

Loads a project.

Parameters

serializer

The serializer. This overload will throw as it's an invalid operation.

Load() [2/2]

None eVision.EasyDeepLearning.EDeepLearningProject.Load	(		self,
		str	projectFile )

Loads a project.

Parameters

projectFile

Project file to load.

RemoveBenchmark()

None eVision.EasyDeepLearning.EDeepLearningProject.RemoveBenchmark	(		self,
		int	toolId,
		int	benchmarkId )

Removes a benchmark.

Parameters

toolId	Index of the tool
benchmarkId	Index of the benchmark to remove

RemoveDataAugmentaton()

None eVision.EasyDeepLearning.EDeepLearningProject.RemoveDataAugmentaton	(		self,
		int	dataAugmentationId )

Removes the given data augmentation.

The data augmentation at index 0 can't be removed.

Parameters

dataAugmentationId

Index of the data augmentation to remove

RemoveSplit()

None eVision.EasyDeepLearning.EDeepLearningProject.RemoveSplit	(		self,
		int	splitId )

Removes a split.

Parameters

splitId

Index of the split

RemoveTool()

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).

Parameters

toolId

Index of the tool to remove

Save() [1/2]

None eVision.EasyDeepLearning.EDeepLearningProject.Save	(		self,
		eVision.ESerializer | None	serializer )

Saves a project and set the project directory to the parent directory of projectFile.

Parameters

serializer

The serializer. This overload will throw as it's an invalid operation.

Save() [2/2]

None eVision.EasyDeepLearning.EDeepLearningProject.Save	(		self,
		str	projectFile )

Saves a project and set the project directory to the parent directory of projectFile.

Parameters

projectFile

Project file to save.

SaveProject()

None eVision.EasyDeepLearning.EDeepLearningProject.SaveProject

(

self

)

Saves an opened project.

SetBenchmark()

None eVision.EasyDeepLearning.EDeepLearningProject.SetBenchmark	(		self,
		int	toolId,
		int	benchmarkId,
		eVision.EasyDeepLearning.EDeepLearningBenchmark	benchmark )

Replaces a benchmark.

Parameters

toolId	Index of the tool
benchmarkId	Index of the benchmark to replace
benchmark	New benchmark

SetDataAugmentationName()

None eVision.EasyDeepLearning.EDeepLearningProject.SetDataAugmentationName	(		self,
		int	dataAugmentationId,
		str	name )

Name of the data augmentation.

Parameters

dataAugmentationId	Index of the data augmentation
name	New name for the data augmentation

SetSplitName()

None eVision.EasyDeepLearning.EDeepLearningProject.SetSplitName	(		self,
		int	splitId,
		str	newName )

Name of the split.

Parameters

splitId	Index of the split
newName	New name for the split

SetToolDataAugmentation()

None eVision.EasyDeepLearning.EDeepLearningProject.SetToolDataAugmentation	(		self,
		int	toolId,
		int	dataAugmentationId )

Data augmentation associated with a tool.

Parameters

toolId	Index of the tool
dataAugmentationId	Index of the data augmentation

SetToolName()

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.

Parameters

toolId	Index of the tool
name	New name for the tool

SetToolSplit()

None eVision.EasyDeepLearning.EDeepLearningProject.SetToolSplit	(		self,
		int	toolId,
		int	splitId )

Dataset split associated with a tool.

Parameters

toolId	Index of the tool
splitId	Index of the split

UnsetGoodLabel()

None eVision.EasyDeepLearning.EDeepLearningProject.UnsetGoodLabel

(

self

)

Remove the good label for EasySegment Unsupervised.

UpdateProjectFileStructure()

None eVision.EasyDeepLearning.EDeepLearningProject.UpdateProjectFileStructure

(

self

)

Updates the project file structure.

Property Documentation

CreationDate

eVision.EasyDeepLearning.EDeepLearningProject.CreationDate = property(_CreationDate__getter, None)

static

\endcond

Creation date of the project represented as the number of seconds since the UNIX epoch.

Dataset

eVision.EasyDeepLearning.EDeepLearningProject.Dataset = property(_Dataset__getter, None)

static

\endcond

Gets the dataset contained in the project.

FileStructureUpdateDescription

eVision.EasyDeepLearning.EDeepLearningProject.FileStructureUpdateDescription = property(_FileStructureUpdateDescription__getter, None)

static

\endcond

Description of the file structure update.

GoodLabel

eVision.EasyDeepLearning.EDeepLearningProject.GoodLabel = property(_GoodLabel__getter, _GoodLabel__setter)

static

\endcond

Good label for EasySegment Unsupervised.

ImageDirectory

eVision.EasyDeepLearning.EDeepLearningProject.ImageDirectory = property(_ImageDirectory__getter, None)

static

\endcond

Image directory.

Calling this method will create the image directory if it doesn't exist.

ImportImageIntoProjectDirectory

eVision.EasyDeepLearning.EDeepLearningProject.ImportImageIntoProjectDirectory = property(_ImportImageIntoProjectDirectory__getter, _ImportImageIntoProjectDirectory__setter)

static

\endcond

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.

ISOCreationDate

eVision.EasyDeepLearning.EDeepLearningProject.ISOCreationDate = property(_ISOCreationDate__getter, None)

static

\endcond

Creation date of the project as an ISO 8601 date (YYYY-MM-DD HH:MM:SS).

Name

eVision.EasyDeepLearning.EDeepLearningProject.Name = property(_Name__getter, _Name__setter)

static

\endcond

Name of the project.

NumDataAugmentations

eVision.EasyDeepLearning.EDeepLearningProject.NumDataAugmentations = property(_NumDataAugmentations__getter, None)

static

\endcond

Number of data augmentation.

Remarks:

A project always contains an empty data augmentation at index 0.

NumSplits

eVision.EasyDeepLearning.EDeepLearningProject.NumSplits = property(_NumSplits__getter, None)

static

\endcond

Number of dataset splits in the project.

NumTools

eVision.EasyDeepLearning.EDeepLearningProject.NumTools = property(_NumTools__getter, None)

static

\endcond

Number of tools.

ProjectDirectory

eVision.EasyDeepLearning.EDeepLearningProject.ProjectDirectory = property(_ProjectDirectory__getter, _ProjectDirectory__setter)

static

\endcond

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.

ProjectFile

eVision.EasyDeepLearning.EDeepLearningProject.ProjectFile = property(_ProjectFile__getter, None)

static

\endcond

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.

Type

eVision.EasyDeepLearning.EDeepLearningProject.Type = property(_Type__getter, _Type__setter)

static

\endcond

Type of the tools in the projects.