README.txt 2.07 KB
Newer Older
Xavier PILLET's avatar
Xavier PILLET committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Hubble Project

Please, follow the following order when exploring the project for the first time :

On the file tree : 

	- source : contain all the Python packages.
	- Data : contain all the saved data.
	- Doc : contain the doc, especially the features.ods file with all the implemented features and a UML directory which contains all the relevant UML diagrams.
	
One the Hubble/source folder :

	- package model (please see the corresponding UML diagram inside Doc):
		- Constant: where all the constants are stored.
		- Event: contains the data for a DataFrame row (for instance, the data for one resource access on OCR).
		- Sequence: contains sequences of Event (for one single user).
17
		- SequenceDf ("Df" for "DataFrame"): Singleton, façade which handles the Sequence objects.
Xavier PILLET's avatar
Xavier PILLET committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31
		- package ocr: contains all the son-classes of the model package, specialized for ocr.
		- package oulad: contains all the son-classes of the model package, specialized for oulad.
		
	- package featureManager (please see the corresponding UML diagram inside Doc): 
		- Constant: where all the constants are stored.
		- FeatureSequence: create all the features from the sequences.
		- FeatureGroup: create all the features for the groups.
		- FeatureMultiGroup: create all the features for many groups.
		- package ocr: contains all the son-classes of the featureManager package, specialized for ocr.
		- package oulad: contains all the son-classes of the featureManager package, specialized for oulad.
		
	- package classifierManager (please see the corresponding UML diagram inside Doc):
		- Constant: where all the constants are stored.
		- Classifier: perform the classification tasks. It's a facade for the Script interface-like classes.
32 33
		- package model: contains the warpers from ScikitLearn algorithms to the Scripts classes.
		- package script: contains the interface-like classes with the different algorithm to perform classification.
Xavier PILLET's avatar
Xavier PILLET committed
34 35
		- package ocr: contains the testUnit class and the main module for ocr.
		- package oulad: contains the testUnit class and the main module for oulad.