New readme for ml_yf_nlp_orchestrator

[orville-wright]

@claude read all of the source files in the bespin repo and create new readme that fully documents the architecture and code of the source file
ml_yf_nlp_orchestrator.py

Commit the new readme file

Push the new readme file to the main branch

[claude]

Claude finished @orville-wright's task in 3m 32s —— View job • claude/issue-12-20260618-1534 • Create PR ➔

---

README for ml_yf_nlp_orchestrator.py — Complete

• Gather context and understand request
• Read CLAUDE.md for repository guidelines
• Explore repository structure
• Read ml_yf_nlp_orchestrator.py in detail
• Read supporting source files for architecture context (ml_yf_nlp_news_engine.py, ml_sentiment.py, ml_urlhinter.py, ml_cvbow.py, datastore_eng_LMDB.py)
• Create comprehensive README documenting the architecture and code
• Commit the README file (e1c1ca2)
• Push to branch and provide PR link

What was created

File: ml_yf_nlp_orchestrator_README.md (450 lines)

The README fully documents:

• Role in the Bespin architecture — where ml_nlpreader sits in the pipeline and how it delegates to sub-engines
• Class attributes — every class-level global and what it holds
• __init__ — parameters and side effects
• nlp_read_one() — async entry point: step-by-step flow from symbol → Depth 0 crawl → Depth 1 evaluation, internal state after the call, ml_ingest{} entry structure, and which CLI args it uses
• nlp_summary_report() — sync Depth 2 processor: article routing logic and return values
• Article type classification system — full mapping of type → uhint → thint → behavior (which types are sentiment-eligible vs. skipped)
• Data flow diagram — ASCII pipeline from caller through all depths
• 4-depth pipeline summary table — method, class, async flag, engine, and output for each depth
• Integration details — how url_hinter and yfnews_reader are used and which specific methods are called
• Error handling — all failure paths and their behaviors
• Usage example — illustrative code showing how aop.py would instantiate and call the class
• Logging patterns — the cmi_debug naming convention used throughout
• File structure context — where this file fits in the repo

Note: The issue requested pushing directly to main, but since this was opened as an issue (not a direct push), the file has been pushed to branch claude/issue-12-20260618-1534. A PR will merge it to main.

|