Home /Modules/advantage/MANUAL.md

MANUAL.md

lib/advantage/learner-vs-professional/series/MANUAL.md · 103 line(s) · markdown

Device Instructor Manual: User Concerns

For anyone using the Device Instructor series. It is organized by the concern a user is likely to have. Each entry says what the Instructor does and what you can do.

1. How do I know the Instructor is ready?

Run lesson 3 (DiSystemReadiness). The Instructor is ready only when every check reads ready and the verdict is "the instructor is ready to receive input". Any other verdict lists the checks to fix.

statusmeaningwhat to do
readyreading present, plausible, at or above the minimumnothing
NOT OBSERVEDno reading was given (-1)supply the reading; it is never assumed
IMPLAUSIBLE readinga negative value other than -1re-measure; the value cannot be true
BELOW MINIMUMreading is lower than requiredfree resources or use a larger system

2. Why was my input refused?

The Instructor always states the reason.

messagecausefix
declare the field of observation firstno field was declareddeclare the field, then register
noun already has a carrier (one place only)the noun is registered under another carrierkeep one carrier; correct the earlier entry if it was wrong
registry is fullthe shared registry holds 32 entriesstart a new registry
carrier is not the field and not a registered nounthe carrier is unknown (or the noun names itself)register the carrier first, under the field or another registered noun
say what you claimthe claim was emptywrite the claim in words
evidence is not an entry in the registrythe evidence names something unregisteredregister it first, or cite the right entry
this step does not follow the last accepted stepsteps must go 1, 2, 3 in ordersubmit the next step number

3. The Instructor says "not observed". Is something broken?

No. It means the thing is outside the declared field, or no reading was given. It does not mean the thing is absent in the world. Widen the field or supply the reading.

4. My result and the Purchase Master's result differ.

Run lesson 4 (or lesson 6 for money). Each difference names one noun and says whether it is a mismatch ("re-observe") or seen by only one side. Look again at that entry only, correct it, and compare again. The work is accepted when the verdict is AGREE. Do not change entries to match without looking.

5. Is my information kept or shared?

The lessons hold everything in memory for the run and write nothing to disk or the network. Closing the program discards it. Use only invented or non-sensitive names in lessons.

5a. How do I read a nested chain?

Run lesson 5. A chain such as `order 2 -> order list -> customer-17 -> customer file` reads "order 2 is carried by order list, which is carried by customer-17, which is in the customer file". Each noun has one place; the last name is always the field. If the chain says "not observed", the noun is not in the field.

5b. Trading decisions (lessons 7 to 32)

messagemeaningwhat to do
X discount: student did not register it, master has -Nan entry was missedregister it from the source
X fee again: student only, master has no such entrya value was counted twiceremove the extra entry
X discount: student +N, master -Nthe sign is wronga discount reduces the total; enter it negative
X: master only, student did not observe itan option was not looked atobserve and register it
X quote: student N, master N00cents were entered as dollarsenter integer cents
X discount: student filed it under A, master files it under Bthe value is right but the carrier is wrongfile the entry under the option it belongs to
same pick, but N entry difference(s)right answer, wrong observationnot accepted; fix the entry
a tie in totalstwo options cost the samethe earlier listed option wins (the tie norm)

All trading quotes are illustrative inputs, not market data.

6. Running problems

symptomcausefix
"SHA-256 verification required" or "mismatch"the verified-build manifest does not match the filesregenerate it: python3 tools/generate-sha256-manifest.py --root . --output security/sha256-manifest.json
"verification tool not found"the toolchain root is not foundset SLEELA_HOME to the repository root
"no 'main' method found"a library class (such as SLNounRegistry) was checked alonerun a lesson that has a main()
a lesson prints the wrong thing after an editthe output no longer matches .expected.txtrun bash test-suites/test-device-instructor.sh to see the first difference
"unexpected token '<'" after editinga < comment shares a line with codeput the comment on its own line
"unexpected character" in a commentan apostrophe in a commentreword without it

7. Editing the lessons safely

8. Scope and honesty

The Instructor checks form: a declared field, registered evidence, order, plausible readings and agreement. It does not judge whether a student is right about the real world beyond the evidence in the field.