Code / public_research_code/README.md

public_research_code/README.md


  1
  # HuleEdu public research code


  2
  


  3
  This directory defines the generated curated research-code edition of HuleEdu.


  4
  HuleEdu is the only authored source for this edition.


  5
  


  6
  Approved changes to these selected files are published automatically to the


  7
  [Codeberg repository](https://codeberg.org/paunchygent/huleedu-research-code)


  8
  and the [static code reader](https://research.hule.education/code/). The full


  9
  public commit SHA identifies the same edition in both places.


  10
  


  11
  The edition contains the reviewed research execution sources for feature


  12
  contracts and extraction, training and score mapping, comparative judgement,


  13
  Bradley--Terry aggregation, and local embeddings. It contains no research


  14
  inputs, model packages, provider payloads, or operational configuration.


  15
  


  16
  Run the deterministic synthetic demonstration after installing the declared


  17
  public dependencies:


  18
  


  19
  ```bash


  20
  python3 -m pip install -r public_research_code/requirements.txt


  21
  python3 public_research_code/run_synthetic_demo.py


  22
  ```


  23
  


  24
  The command imports the current HuleEdu feature registry, prediction-mapping,


  25
  and Bradley--Terry modules. It uses only literal synthetic numeric inputs and


  26
  does not create files, start services, contact a network endpoint, or load a


  27
  model.


  28
  


  29
  The package is licensed under Apache-2.0; see the root `LICENSE` file.