Wiki source code of The AISOP recipe
Version 9.1 by AISOP Admin on 2025/01/14 21:23
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="jumbotron" %) |
| 2 | ((( | ||
| 3 | (% class="container" %) | ||
| 4 | ((( | ||
| |
1.4 | 5 | = The AISOP recipe = |
| |
1.1 | 6 | |
| |
1.4 | 7 | The AISOP webapp is a service built as the result of various training and configurations. |
| 8 | This recipe explains how to extract the content fragments, annotate them, and create model trained on it. This will let us create a pipeline and a seminar on which we can analyse portfolios. | ||
| |
1.1 | 9 | ))) |
| 10 | ))) | ||
| 11 | |||
| |
1.5 | 12 | |
| |
1.4 | 13 | == Basic Terms == |
| |
1.1 | 14 | |
| |
1.4 | 15 | The context of the AISOP-web-app usage is that of a course at learning institution which typically has fixed students and fixed contents. A course can contain multiple courses or modules. |
| |
1.1 | 16 | |
| |
1.4 | 17 | * **AISOP Web-app:** The nodeJS server that interfaces with the portfolio-composing system. |
| 18 | * **Portfolio:** the content written by a student in order to represent his or her progress, learning and knowledge using a textual and graphical form. Generally expressed in HTML, can be embedded in various web-pages. | ||
| 19 | * **Course-contents:** The set of slides, their annotations, the videos and handouts that normally read by students and teachers. | ||
| 20 | * **Analysis:** The set of programmes that recognize and measure the contents of a portfolio. Often also the name of the resulting interactive presentation (which can feature summaries or enriched portfolio views). | ||
| 21 | * **Composition Platform:** A space where the portfolio is written. Normally a web-space. In AISOP we have focussed on the classical e-portfol;io composition platform Mahara (a PHP server). | ||
| |
1.1 | 22 | |
| |
1.4 | 23 | ---- |
| |
1.1 | 24 | |
| |
1.4 | 25 | == 1) Data Preparation == |
| |
1.1 | 26 | |
| |
1.4 | 27 | === 1.1: Make a Concept Map === |
| |
1.1 | 28 | |
| |
1.4 | 29 | Employing tools such as CMapTools, create a graphical concept map that represents the topics of the course. This concept map can be familiar with the teachers and learners of this course as a way to show the paths through the content. |
| |
1.1 | 30 | |
| |
1.4 | 31 | From the concept map, extract a .cxl file which carries the same information and will be presented on the web-page. |
| |
1.1 | 32 | |
| |
1.4 | 33 | From the concept map, also extract a hierarchy of topics, assuming there is more than (approx) 10 topics in the map. The hierarchy should be a text file with a label per line and the label indented to the right in case of children relation as in the following example: |
| |
1.1 | 34 | |
| |
1.4 | 35 | >Algorithmization |
| 36 | > Flow Charts | ||
| 37 | > Programming | ||
| 38 | > Programming Paradigm | ||
| |
1.6 | 39 | > Imperative Programming |
| 40 | >Data-Structure | ||
| 41 | > .... | ||
| 42 | >Operating System | ||
| 43 | > .... | ||
| |
1.1 | 44 | |
| |
1.6 | 45 | We'll name this file labels-all-depths.txt. From this text file, extract a text file with only the top labels (in the extract above only Algorithmization, Data-Structure and Operating System), named labels-depth1.txt. |
| 46 | |||
| |
1.4 | 47 | === 1.2: Extract Text of the Course Content === |
| |
1.1 | 48 | |
| |
1.4 | 49 | In order for the topic recognition to work, a model needs to be trained that will recognize the words used by the students to denote a part or another of the course. This allows to create relations between the concepts of the course and the paragraphs of the portfolio and offer these in the interactive dashboards. The training is the result of annotating fragments of texts which, first, need to be extracted from their media, be them PDF files, PowerPoint slides, scanned texts or student works. These texts will not be shared so that even protected material or even personal-information carrying texts can be used. |
| |
1.1 | 50 | |
| |
1.4 | 51 | Practically: |
| |
1.1 | 52 | |
| |
1.6 | 53 | * Make all documents accessible for you to open and browse (e.g. download them or get the authorized accesses) |
| 54 | * Install and launch the [[clipboard extractor>>https://gitlab.com/aisop/aisop-hacking/-/tree/main/aisop-clipboard-extractor?ref_type=heads]] which will gather the fragments in a text file | ||
| 55 | * Go through all contents and copy each fragment. A fragment is expected to be the size of a paragraph so this is what you should copy. | ||
| 56 | * The extractor should have copied all the fragments in one file. Which we shall call extraction.json. | ||
| 57 | * The least amount of content to be extracted is the complete set of slides and their comments. We recommend to use past students' e-portfolios too. We had rather good experience with about 1000 fragments for a course. | ||
| 58 | * If interrupted, the process may create several JSON files. You can combine them using the [[merge-tool>>https://gitlab.com/aisop/aisop-hacking/-/tree/main/merge-json-files]]. | ||
| |
1.1 | 59 | |
| |
1.4 | 60 | === 1.3: Annotate Text Fragments === |
| 61 | |||
| |
1.6 | 62 | It is time to endow the fragments with topics so that we can recognize students' paragraphs' topics. In AISOP, we have used the (commercial) [[prodigy>>https://prodi.gy/]] for this task in two steps which, both, iterate through all fragments to give them topics. |
| |
1.1 | 63 | |
| |
8.1 | 64 | **The first step: top-level-labels:** This is the simple [["text classifier" recipe>>https://prodi.gy/docs/recipes#textcat]] of prodigy: we can invoke the following command for this: ##prodigy textcat.manual the-course-name-l1 ./fragments.jsonl ~-~-label labels-depth1.txt## which will offer a web-interface on which each fragment is annotated with the (top-level) label. This web-interface can be left running for several days. |
| 65 | Then extract the content into a file: ##prodigy db-out the-course-name-l1 > the-course-name-dbout.jsonl## | ||
| |
1.6 | 66 | |
| |
9.1 | 67 | **The second step is the hierarchical annotation** [[custom recipe>>https://gitlab.com/aisop/aisop-nlp/-/tree/main/hierarchical_annotation?ref_type=heads]] (link to become public soon): The same fragments are now annotated with the top-level annotation and all their children. E.g. using the command ##python -m prodigy subcat_annotate_with_top2 the-course-name-l2 \ |
| 68 | the-course-name-dbout.jsonl labels-all-depths.txt -F ./subcat_annotate_with_top2.py##. | ||
| |
1.6 | 69 | |
| |
1.7 | 70 | The resulting data-set can be extracted out of prodigy using the db-out recipe, e.g. prodigy db-out the-course-name-l2 the-course-name-l2-dbout or can be converted to a spaCy dataset for training e.g. using the command xxxxx (see [[here>>https://gitlab.com/aisop/aisop-nlp/-/tree/main/it3/fundamental-principles]]) |
| |
1.6 | 71 | |
| 72 | |||
| |
1.4 | 73 | ---- |
| |
1.1 | 74 | |
| |
1.4 | 75 | == 2) Deployment == |
| |
1.1 | 76 | |
| |
1.4 | 77 | === 2.1 Train a Recognition Model === |
| |
1.1 | 78 | |
| |
1.7 | 79 | See [[here>>https://gitlab.com/aisop/aisop-nlp/-/tree/main/it3/fundamental-principles]]. |
| |
1.4 | 80 | |
| 81 | === 2.2 Create a Pipeline === | ||
| 82 | |||
| |
1.7 | 83 | ... write down the configuration JSON of the pipeline, get inspired [[pipeline-medieninderlehre.json>>https://gitlab.com/aisop/aisop-webapp/-/blob/main/config/couchdb/pipeline-medieninderlehre.json?ref_type=heads]] |
| |
1.4 | 84 | |
| 85 | === 2.3 Create a Seminar and Import Content === | ||
| 86 | |||
| 87 | ... | ||
| 88 | |||
| |
1.7 | 89 | Create a seminar with the web-interface, associate the appropriate pipeline. |
| 90 | |||
| |
1.4 | 91 | === 2.4 Interface with the composition platform === |
| 92 | |||
| |
1.7 | 93 | See the Mahara authorization configuration. |
| |
1.4 | 94 | |
| 95 | ---- | ||
| 96 | |||
| 97 | == 3) Usage == | ||
| 98 | |||
| 99 | === 3.1 Invite Users === | ||
| 100 | |||
| 101 | ... | ||
| 102 | |||
| 103 | === 3.2 Verify Imports and Analyses === | ||
| 104 | |||
| 105 | ... | ||
| 106 | |||
| 107 | === 3.3 Observe Usage and Reflect on Quality === | ||
| 108 | |||
| 109 | ... | ||
| 110 | |||
| 111 | === 3.4 Gather Enhancements === | ||
| 112 | |||
| 113 | ... on the web-app, on the creation process, and on the course |