fix: Expand a bit on the README
This commit is contained in:
parent
7c97a67a7b
commit
7f8c1e3c45
|
@ -1,12 +1,17 @@
|
||||||
|
## About
|
||||||
|
This repository creates a react webpage that allows to extract a utility function from possibly inconsistent binary comparisons
|
||||||
|
|
||||||
## Object structure
|
## Object structure
|
||||||
The core structure is json array of objects. Only the "name" attribute is necessary; the id is also internally necessary but it's created on the fly if it doesn't exist. The reason that ids are needed is that comparing objects is annoying.
|
The core structure is json array of objects. Only the "name" attribute is required; the id is also internally required but it's created on the fly if it doesn't exist. The reason that ids are needed is that comparing objects is annoying. I think that one object must have the `isReferenceValue` property as true, but I'm not sure.
|
||||||
|
|
||||||
```
|
```
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"name": "Peter Parker",
|
"name": "Peter Parker",
|
||||||
"someOptionalKey": "...",
|
"someOptionalKey": "...",
|
||||||
"anotherMoreOptionalKey": "..."
|
"anotherMoreOptionalKey": "...",
|
||||||
|
"isReferenceValue": true
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 2,
|
"id": 2,
|
||||||
|
|
|
@ -13,7 +13,8 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Categorizing Variants of Goodhart's Law",
|
"name": "Categorizing Variants of Goodhart's Law",
|
||||||
"url": "https://arxiv.org/abs/1803.04585"
|
"url": "https://arxiv.org/abs/1803.04585",
|
||||||
|
"isReferenceValue": true
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "The Vulnerable World Hypothesis",
|
"name": "The Vulnerable World Hypothesis",
|
||||||
|
@ -36,4 +37,3 @@
|
||||||
"url": "https://en.wikipedia.org/wiki/A_Mathematical_Theory_of_Communication"
|
"url": "https://en.wikipedia.org/wiki/A_Mathematical_Theory_of_Communication"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
Loading…
Reference in New Issue
Block a user