vix.ing · top · new · best · stats · spec

vixing.json

Machine analysis is expensive, so vixing does not insist on being the one to do it. Publish analyses of papers vixing has already ingested and they render on the paper's page beside vixing's own, credited to you and to your model.

Publish

Serve files named *.vixing.json:

{
  "vixing": 1,
  "paper": {
    "doi": "10.1234/birds"
  },
  "analyses": [
    {
      "kind": "summary",
      "content": "A 2-3 sentence plain-language summary.",
      "provenance": {
        "model": "llama-3-70b",
        "method": "local ollama pipeline"
      }
    }
  ],
  "author": {
    "name": "Alice Blogger",
    "url": "https://alice.example.com"
  }
}

Discovery

Pull-based, two flavours:

Send the feed or repo url to [email protected] and vixing polls it daily.

Envelope

{
  "type": "object",
  "properties": {
    "vixing": {
      "type": "integer",
      "enum": [
        1
      ]
    },
    "paper": {
      "type": "object",
      "properties": {
        "doi": {
          "type": "string"
        },
        "arxiv_id": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "analyses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string"
          },
          "content": {},
          "provenance": {
            "type": "object",
            "properties": {
              "model": {
                "type": "string"
              },
              "method": {
                "type": "string"
              }
            },
            "required": [
              "model"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "kind",
          "content",
          "provenance"
        ],
        "additionalProperties": false
      }
    },
    "author": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "vixing",
    "paper",
    "analyses",
    "author"
  ],
  "additionalProperties": false
}

Kinds

content must match the schema for its kind exactly — no missing fields, no extra ones.

classification

{
  "type": "string",
  "enum": [
    "empirical",
    "theory",
    "both",
    "other"
  ]
}

one_liner

{
  "type": "string"
}

summary

{
  "type": "string"
}

eli5

{
  "type": "string"
}

outline

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "section": {
        "type": "string"
      },
      "note": {
        "type": "string"
      }
    },
    "required": [
      "section",
      "note"
    ],
    "additionalProperties": false
  }
}

argument

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "step": {
        "type": "string"
      },
      "support": {
        "type": "string"
      }
    },
    "required": [
      "step",
      "support"
    ],
    "additionalProperties": false
  }
}

assumptions

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "assumption": {
        "type": "string"
      },
      "stated": {
        "type": "boolean"
      }
    },
    "required": [
      "assumption",
      "stated"
    ],
    "additionalProperties": false
  }
}

claims

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "claim": {
        "type": "string"
      },
      "evidence_type": {
        "type": "string",
        "enum": [
          "proof",
          "experiment",
          "simulation",
          "argument",
          "citation"
        ]
      }
    },
    "required": [
      "claim",
      "evidence_type"
    ],
    "additionalProperties": false
  }
}

links

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "url": {
        "type": "string"
      },
      "kind": {
        "type": "string",
        "enum": [
          "code",
          "dataset",
          "project",
          "demo",
          "other"
        ]
      }
    },
    "required": [
      "url",
      "kind"
    ],
    "additionalProperties": false
  }
}

glossary

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "term": {
        "type": "string"
      },
      "definition": {
        "type": "string"
      }
    },
    "required": [
      "term",
      "definition"
    ],
    "additionalProperties": false
  }
}

audience

{
  "type": "object",
  "properties": {
    "who": {
      "type": "string"
    },
    "prerequisites": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "who",
    "prerequisites"
  ],
  "additionalProperties": false
}

open_questions

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "question": {
        "type": "string"
      },
      "why": {
        "type": "string"
      }
    },
    "required": [
      "question",
      "why"
    ],
    "additionalProperties": false
  }
}

funding

{
  "type": "object",
  "properties": {
    "funders": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "conflicts": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "funders",
    "conflicts"
  ],
  "additionalProperties": false
}

figure

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "label": {
          "type": "string"
        },
        "caption": {
          "type": "string"
        }
      },
      "required": [
        "label",
        "caption"
      ],
      "additionalProperties": false
    },
    {
      "type": "null"
    }
  ]
}

methods_card

{
  "type": "object",
  "properties": {
    "n": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "population": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "study_type": {
      "type": "string",
      "enum": [
        "rct",
        "observational",
        "bench",
        "simulation",
        "other"
      ]
    },
    "effect_sizes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "confidence_intervals": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "n",
    "population",
    "study_type",
    "effect_sizes",
    "confidence_intervals"
  ],
  "additionalProperties": false
}

rigor_signals

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "signal": {
        "type": "string",
        "enum": [
          "preregistered",
          "power_analysis",
          "code_available",
          "data_available",
          "fair_baselines",
          "ablations"
        ]
      },
      "present": {
        "type": "boolean"
      },
      "evidence": {
        "type": "string"
      }
    },
    "required": [
      "signal",
      "present",
      "evidence"
    ],
    "additionalProperties": false
  }
}

limitations

{
  "type": "object",
  "properties": {
    "admitted": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "noticed": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "admitted",
    "noticed"
  ],
  "additionalProperties": false
}

benchmark_tables

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "benchmark": {
        "type": "string"
      },
      "rows": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "method": {
              "type": "string"
            },
            "metric": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "method",
            "metric",
            "value"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "benchmark",
      "rows"
    ],
    "additionalProperties": false
  }
}

hype_delta

{
  "type": "object",
  "properties": {
    "score": {
      "type": "integer",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ]
    },
    "evidence": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "claimed": {
            "type": "string"
          },
          "supported": {
            "type": "string"
          }
        },
        "required": [
          "claimed",
          "supported"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "score",
    "evidence"
  ],
  "additionalProperties": false
}

replication_forecast

{
  "type": "object",
  "properties": {
    "probability": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "rationale": {
      "type": "string"
    }
  },
  "required": [
    "probability",
    "rationale"
  ],
  "additionalProperties": false
}

key_equations

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "equation": {
        "type": "string"
      },
      "meaning": {
        "type": "string"
      }
    },
    "required": [
      "equation",
      "meaning"
    ],
    "additionalProperties": false
  }
}

proof_sketch

{
  "type": "array",
  "items": {
    "type": "string"
  }
}