Skip to content

docs(paper): remaining revisions from JOSS paper review (#447) - #459

Draft
phanindra-max wants to merge 1 commit into
devfrom
paper/447-rewrite
Draft

phanindra-max wants to merge 1 commit into
devfrom
paper/447-rewrite

Conversation

@phanindra-max

Copy link
Copy Markdown
Member

Work in progress on the remaining points from @jansim's paper review in #447. The first round of fixes is already on main (#450).

Edit paper.md on this branch, for example in github.dev: https://github.dev/LAiSER-Software/extract-module/tree/paper/447-rewrite. Each push that changes paper.md builds the JOSS PDF under Checks → Paper Draft.

Setup

  • Fix local repo (git reset --hard origin/main) (optional)
  • Open paper.md in github.dev on this branch

Write (in the authors' own words)

  • Rewrite the AI usage disclosure: tools, versions, where they were used, scope, and human review (JOSS AI policy)
  • Read the ESCOX paper (Kavargyris et al., 2025)
  • Add 2–4 sentences comparing LAiSER with the LLM-based tools
  • Rewrite Software design: walk through what happens to one document
  • Decide the syllabus wording, or fix the syllabus prompt (input_type="syllabus" currently sends a placeholder prompt, laiser/config.py:228)
  • Rewrite the Summary in our own voice (optional)

Check and ship

  • Commit, mark ready, and read the Paper Draft PDF
  • Fact-check claims against the code and paper.bib
  • Merge to dev, then dev → main

Close the loop

🤖 Generated with Claude Code

Empty commit so a draft PR can track the remaining #447 work.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Code Hygiene

The following items are defined but not yet in active use. Routine cleanup — no impact on functionality.

  • laiser/llm_methods.py:87 — unused variable 'args' (100% confidence)
  • laiser/llm_models/llama_cpp_handler.py:45 — unused variable 'chat_format' (100% confidence)
  • laiser/llm_models/llama_cpp_handler.py:86 — unused variable 'exc' (100% confidence)
  • laiser/llm_models/llama_cpp_handler.py:86 — unused variable 'exc_type' (100% confidence)
  • laiser/llm_models/llama_cpp_handler.py:86 — unused variable 'tb' (100% confidence)
  • laiser/llm_models/llm_router.py:71 — unused variable 'args' (100% confidence)
  • laiser/llm_models/llm_router.py:86 — unused variable 'args' (100% confidence)
  • laiser/llm_models/llm_router.py:89 — unused variable 'args' (100% confidence)
  • laiser/services.py:132 — unused variable 'raw_description' (100% confidence)

@github-actions

Copy link
Copy Markdown

Complexity Analysis

Average: C — Moderate (13.75)

Hotspots tracked below. These are functional, well-exercised components — listed for visibility as the codebase scales.

Grade Name Type Score
F FAISSIndexManager.initialize_index Method 51
E SkillExtractionService.extract_and_align_core Method 36
E FAISSIndexManager.search_similar_skills Method 32
D ResponseParser._parse_skills_from_response Method 24
D FAISSIndexManager Class 22
C ResponseParser.parse_knowledge_task_response Method 20
C _BaseTaxonomyFAISSIndexManager.search_similar Method 18
C ResponseParser Class 17
C ResponseParser.parse_ksa_extraction_response Method 16
C ResponseParser.parse_skill_extraction_response Method 15
C openai_generate Function 14
C parse_output_vllm Function 13
C AlignmentService.align Method 11
C anthropic_generate Function 11
C LLMRouter._initialize_components Method 11
B SkillExtractionService._deduplicate Method 10
B load_model_from_vllm Function 10
B GeminiAPI.generate_with_config Method 10
B _BaseTaxonomyFAISSIndexManager.initialize_index Method 9
B ResponseParser.parse_ksa_details_response Method 8
B SkillExtractionService Class 8
B _BaseTaxonomyFAISSIndexManager Class 8
B llm_generate Function 8
B SkillExtractorRefactored._expand_allowed_sources Method 7
B get_completion_vllm Function 7
B LLMRouter.generate Method 7
B llama_cpp_chat Function 7
B AlignmentService Class 6
B SkillExtractionService._normalize_mixed_concept_rows Method 6
B fetch_model_output Function 6
B LlamaCppBackend.__init__ Method 6
B GeminiAPI Class 6

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant