Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -8,33 +8,36 @@
8	8
9	9	Minimum: this allows the AISOP web-app to run:
10	10
11		-- title and description
12		-- set of labels of level 1 and of other levels
13		-- concept-map (exported in CXL) where the labels are nodes
14		-- spacy model that allows the text-classification of paragraphs of portfolios made in this course: one for level 1, and one for each of the level 1 topics (to classify its subtopics)
15		-- sequence of analysis scripts and aggregation scripts to deliver the portfolio explorer and portfolio dashboard
	11	+* title and description
	12	+* set of labels of level 1 and of other levels
	13	+* concept-map (exported in CXL) where the labels are nodes
	14	+* spacy model that allows the text-classification of paragraphs of portfolios made in this course: one for level 1, and one for each of the level 1 topics (to classify its subtopics)
	15	+* sequence of analysis scripts and aggregation scripts to deliver the portfolio explorer and portfolio dashboard
16	16
17	17	Optional: this allows others to further develop the domain
18	18
19		-- source content which contains the sentences used for training
20		-- extracted sentences/fragments
21		-- annotations for these extracted sentences within the labels of level 1 and the others
22		-- annotation statistics and model training results (in the form of statistics)
23		-- test sentences to verify the proper elementary function of the classifiers
24		-- test portfolios to verify the proper function
	19	+* source content which contains the sentences used for training
	20	+* extracted sentences/fragments
	21	+* annotations for these extracted sentences within the labels of level 1 and the others
	22	+* annotation statistics and model training results (in the form of statistics)
	23	+* test sentences to verify the proper elementary function of the classifiers
	24	+* test portfolios to verify the proper function
25	25
26		-
27	27	### Packaging of a domain
28	28
29	29	We propose that a domain be packaged as a directory which can be shared as a repository and to contain the following directory organization:
30	30
31		-- the directory-name reflects the course name
32		-- the directory contains a file `about.json` with the properties `title`, `description`, `language` (in iso-639-3) and an array of strings for the authors, `subjects` an array of strings containing the LC-subject-classification, and `logo` (the link to a logo)
33		-- the directory contains a file `license.txt` with the license text
34		-- the directory contains a `labels.txt` file with a list of label names, organized in a hierarchy by simple indenting
35		-- the directory contains a file `pipeline.json` with the steps of the analysis and aggregation (TODO: more details, THINKME: added CSS?)
36		- - the pipeline refers to the model spacy directories (level 1 and one for the children of each level 1) which are included
37		-- any extra file or directory mentioned as link
38		-- any file used for development, documented by a `README.md`
	30	+* the directory-name reflects the course name
	31	+* the directory contains a file `about.json` with the properties `title`, `description`, `language` (in iso-639-3) and an array of strings for the authors, `subjects` an array of strings containing the LC-subject-classification, and `logo` (the link to a logo)
	32	+* the directory contains a file `license.txt` with the license text
	33	+* the directory contains a `labels.txt` file with a list of label names, organized in a hierarchy by simple indenting
	34	+* the directory contains a file `pipeline.json` with the steps of the analysis and aggregation
	35	+ * the pipeline refers to the model spacy directories (level 1 and one for the children of each level 1) which are included
	36	+* the concept-map used called `cmap.cxl` and its source `cmap.cmap` (for dev)
	37	+* all models:
	38	+ * the `l1-model` directory is the spacy model for the classifier for the l1-topics
	39	+ * the `l2-models` contains a directory for each l1-topic which contains a spacy model for the sub-labels of this l1-topic
	40	+* any extra file or directory mentioned as link
	41	+* any file used for development, documented by a `README.md`
39	39
40	40	All paths of links used in the `about.json` and `pipeline.json` files can be resolved in a relative manner. For them to be recognized, we recommend to express relative paths with the syntax of starting with `./` as in `"logo":"./my-logo.svg"`. This allows the web-app to perform relative resolution in a secure way (not going outside of the domain directory except for known places) before it is given to the web-server or to the analysis scripts.