Commit 1892e494 authored by sim's avatar sim

[DOC] Fix markup and typos

parent 5252b47b
...@@ -3,9 +3,10 @@ ...@@ -3,9 +3,10 @@
## Node ## Node
The table (nodes) is a list of nodes: [Node] The table (nodes) is a list of nodes: `[Node]`
Each Node has: Each Node has:
- a typename - a typename
- a parent_id - a parent_id
- a name - a name
...@@ -13,62 +14,62 @@ Each Node has: ...@@ -13,62 +14,62 @@ Each Node has:
### Each Node has a parent_id ### Each Node has a parent_id
Node A Node A
├── Node B ├── Node B
└── Node C └── Node C
If Node A is Parent of Node B and Node C If Node A is Parent of Node B and Node C
then NodeA.id == NodeB.parent_id == NodeC.parent_id. then NodeA.id == NodeB.parent_id == NodeC.parent_id.
### Each Node has a typename ### Each Node has a typename
Notation: Node[foo](bar) is a Node of typename "foo" and with name "bar". Notation: `Node[foo](bar)` is a Node of typename "foo" and with name "bar".
Then: Then:
- Then Node[project] is a project.
- Then Node[corpus] is a corpus.
- Then Node[document] is a document.
- Then Node[project] is a project.
- Then Node[corpus] is a corpus.
- Then Node[document] is a document.
### Each Node as a typename and a parent
### Each Node as a typename and a parent
Node[user](name) Node[user](name)
├── Node[project](myProject1) ├── Node[project](myProject1)
│   ├── Node[corpus](myCorpus1) │   ├── Node[corpus](myCorpus1)
│   ├── Node[corpus](myCorpus2) │   ├── Node[corpus](myCorpus2)
│   └── Node[corpus](myCorpus3) │   └── Node[corpus](myCorpus3)
└── Node[project](myProject2) └── Node[project](myProject2)
/!\\ 3 way to manage rights of the Node:
/!\ 3 way to manage rights of the Node: 1. Then Node[User] is a folder containing all User projects and corpus and
1) Then Node[User] is a folder containing all User projects and corpus and documents (i.e. Node[user] is the parent_id of the children).
documents (i.e. Node[user] is the parent_id of the children). 2. Each node as a user_id (mainly used today)
2) Each node as a user_id (mainly used today) 3. Right management for the groups (implemented already but not
3) Right management for the groups (implemented already but not used since not connected to the frontend).
used since not connected to the frontend).
## Global Parameters ## Global Parameters
Global User is Gargantua (Node with typename User). Global User is Gargantua (Node with typename user).
This node is the parent of the others Nodes for parameters. This node is the parent of the other nodes for parameters.
Node[user](gargantua) (gargantua.id == Node[user].user_id)
├── Node[TFIDF-Global](global) : without group
│   ├── Node[tfidf](database1)
│   ├── Node[tfidf](database2)
│   └── Node[tfidf](database2)
└── Node[anotherMetric](global)
Node[user](gargantua) (gargantua.id == Node[user].user_id)
├── Node[TFIDF-Global](global) : without group
│   ├── Node[tfidf](database1)
│   ├── Node[tfidf](database2)
│   └── Node[tfidf](database2)
└── Node[anotherMetric](global)
## NodeNgram ## NodeNgram
NodeNgram is a relation of a Node with a ngram: NodeNgram is a relation of a Node with a ngram:
- document and ngrams
- metrics and ngrams (position of the node metrics indicates the - documents and ngrams
context) - metrics and ngrams (position of the node metrics indicates the
context)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment