FlaneAI commited on
Commit
434ba34
·
verified ·
1 Parent(s): e2c3c1c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -25
README.md CHANGED
@@ -4,7 +4,7 @@ language:
4
  license: other
5
  license_name: undecided
6
  license_link: LICENSE
7
- pretty_name: symmix Knowledge Base
8
  size_categories:
9
  - 1K<n<10K
10
  task_categories:
@@ -32,11 +32,11 @@ tags:
32
  - python
33
  ---
34
 
35
- # symmix
36
 
37
- **symmix** is a hand-written knowledge base of quantitative formulas, concepts, processes and rules, together with a small, dependency-free Python engine that answers practical numerical questions from it.
38
 
39
- Nothing in symmix is trained. Every formula, concept, variable, rule and worked example was written by hand. Each answer shows the numbers it read from the question, the formulas it ran, the assumptions it made and the reasoning it used, so every result can be checked.
40
 
41
  ```text
42
  $ python3 -m symmix "What is the monthly payment on a 300000 loan at 5% over 20 years?"
@@ -94,7 +94,7 @@ Other domains include earth science, reliability, acoustics, project management,
94
 
95
  ## Quick start
96
 
97
- symmix needs Python 3 and nothing else. Clone or download this repository, then run from its root:
98
 
99
  ```bash
100
  python3 -m symmix "How much will 2000 be worth after 8 years at 4%?"
@@ -187,21 +187,6 @@ Edge relations and counts: `feature` 2,001, `input` 1,084, `output` 523, `explai
187
 
188
  The vectors are sparse lexical weights over written terms. They are not learned embeddings, and two items are similar only when they share words, character sequences or features. The graph is hand-built and has not been checked against an independent reference.
189
 
190
- ## Evaluation and limitations
191
-
192
- symmix is a sample of quantitative knowledge, not a large corpus, and it is not a general language model.
193
-
194
- - **Scope.** It answers questions that match its formulas. It does not do open-ended language tasks, reasoning beyond its knowledge base, or explanation beyond the written concept texts.
195
- - **Unrelated questions.** On a probe of 89 questions outside the knowledge base, symmix answered 27. Retrieval can clear the threshold on a single shared word, so the abstain threshold is a trade-off, not a guarantee.
196
- - **Wrong links.** A number can link to the wrong variable and still produce an answer. Check the "Read from your question" list before relying on a result.
197
- - **Approximations.** Formulas are approximations under the assumptions they list.
198
- - **Label phrasing.** A number links only to a label beside it, within a few words. Write `name=value` when in doubt.
199
- - **Units.** Some unit forms are not converted, for example kelvin after a number (`400 K` is read as 400,000) and scientific notation written as `2e-7` (only the mantissa links). Write temperatures in degrees Celsius and expand scientific notation to a decimal.
200
- - **Shared aliases.** Some alias phrases belong to more than one item. Other signals then decide between them.
201
- - **Not benchmarked.** No comparison against a language model or an independent benchmark has been run, and none is claimed.
202
-
203
- The `evaluation/` folder contains question-set scripts used during development. Their results are not reported in this card.
204
-
205
  ## Adding knowledge
206
 
207
  1. Add or edit JSON in `kb/`. Every new formula needs worked examples.
@@ -220,10 +205,6 @@ tests/ 206 tests in 14 modules
220
  evaluation/ question-set scripts used during development
221
  ```
222
 
223
- ## Citation
224
-
225
- If you use symmix in research or teaching, please cite the repository and state the version (knowledge base: 401 formulas, 377 concepts).
226
-
227
  ## License
228
 
229
- License not yet chosen. See `LICENSE` once it is added.
 
4
  license: other
5
  license_name: undecided
6
  license_link: LICENSE
7
+ pretty_name: Causal Graph
8
  size_categories:
9
  - 1K<n<10K
10
  task_categories:
 
32
  - python
33
  ---
34
 
35
+ # Causal Graph
36
 
37
+ This is a hand-written knowledge base of quantitative formulas, concepts, processes and rules, together with a small, dependency-free Python engine that answers practical numerical questions from it.
38
 
39
+ Nothing is trained. Every formula, concept, variable, rule and worked example was written by hand. Each answer shows the numbers it read from the question, the formulas it ran, the assumptions it made and the reasoning it used, so every result can be checked.
40
 
41
  ```text
42
  $ python3 -m symmix "What is the monthly payment on a 300000 loan at 5% over 20 years?"
 
94
 
95
  ## Quick start
96
 
97
+ Causal Graph needs Python 3 and nothing else. Clone or download this repository, then run from its root:
98
 
99
  ```bash
100
  python3 -m symmix "How much will 2000 be worth after 8 years at 4%?"
 
187
 
188
  The vectors are sparse lexical weights over written terms. They are not learned embeddings, and two items are similar only when they share words, character sequences or features. The graph is hand-built and has not been checked against an independent reference.
189
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
190
  ## Adding knowledge
191
 
192
  1. Add or edit JSON in `kb/`. Every new formula needs worked examples.
 
205
  evaluation/ question-set scripts used during development
206
  ```
207
 
 
 
 
 
208
  ## License
209
 
210
+ Apache 2.0