¶ Getting started with KNOX
This page serves as a starting point for any new KNOX members. It will (briefly) explain how to get started with the project and how the wiki should be used and updated.
First time here?
- Read the Agreements made for KNOX
- Find the documentation for components on the navigation bar on the left - The ones below "Old KNOX" is from an older version, before KNOX was completely rewritten
Editing and updating the wiki
- Check if there is a page for what you want to document or if a new one should be made
- If a page has become obsolete, it should be updated or deleted
- If a guide has insufficient information, it should be updated by the group that noticed. KNOX uses "spejder reglen" defined by Robert Baden-Powell (see citation)
"Prøv på at efterlade denne [wiki] en lille smule bedre, end du fandt den. Og når din sidste stund en gang kommer, kan du dø lykkelig i bevidstheden om, at du i hvert fald ikke har spildt dit liv, men gjort dit bedste" - Robert Baden-Powell
¶ KNOX pipeline
¶ KNOX architecture
The component diagram can be edited on draw.io.
¶ Background for KNOX
Written by KNOX 2023 (updated 13/12-2023)
KNOX, also known as the Knowledge Engineering Toolbox, is a multi-generational, collaborative project, offered as a semester project for students in the fifth semester at Aalborg University. KNOX being a multi-generational project means that it is a long-term project, where students will be able to build upon the work created by their predecessors. KNOX being a collaborative project means that 7 groups will be working collectively to achieve a common goal while cooperating on the same code base. The work being done, and the software being created will be well-documented on wiki.knox.aau.dk. Such that students on the next iteration of the project will be able to continue the work with KNOX and add their contributions to the KNOX project.
KNOX is a toolbox used to verify and sort a vast amount of information, for a regular user. The data being used in KNOX originates from Grundfos, Nordjyske Medier Archive and EHCI & MIMIC-III. The goal of this year’s iteration of KNOX is to create one knowledge graph based on the different datasets and a single generalized ontology. Lastly, a shared interface will be implemented, with a focus on frontend-backend architecture. Besides these main goals, new functionality and other advanced components can be added to KNOX as well.
¶ Agreements made in KNOX
All agreements made in KNOX will be written here. If a new KNOX team wishes to change them, they should edit the page so it's always up to date. If new agreements does not conform with previously agreed upon conventions, the existing documentation should be changed to be in accordance with this new convention.
¶ GIT repository naming convention
Updated 2023-12-04
Repositories should be named as <LayerName>_<Functionality> in PascalCase. There are currently three layers in the pipeline (PreprocessingLayer, DatabaseLayer and FunctionalityLayer).
Example: KnowledgeLayer_General, DatabaseLayer_WordcountAPI, PreprocessingLayer_RelationExtraction
If a repository becomes obsolete, it should be renamed such that it begins with'OBSOLETE' in the following manner: OBSOLETE_PreprocessingLayer_RelationExtraction
¶ Changes in non-primary repositories
Updated 2021-12-07
If a group wants to make changes in a non-primary repository (meaning it's a repository the group doesn't normally make changes to) the procedure is as follows:
- Create a Pull Request for the suggested change
- Write the group primarily responsible for the repository - explain why the pull request was made and ask when it can be expected to be reviewed
- The other group will merge the pull request or request changes
¶ Wiki entries
Updated 2023-12-04
¶ Markdown
Use markdown(!) when creating and editing wiki pages. This ensures a standardized format accross pages and the possibility of copy-pasting relevant sections or information between them.
¶ Structure of functionality sections
Each functionality section must contain a section about the following
- How to get started
- The input that the solution takes
- The output it produces
- Future work