Factor Report logo

Factor Report

Community
minihellboy
factor-report

Generate static reports, tearsheets, and exports from FactorMiner artifacts — markdown/HTML research notes, plots, and library exports (JSON/CSV/formulas). Use to package a finished research run for review. Triggers on "generate report", "factor report", "research note", "tearsheet", "visualize factors", "export library", "write up the results".

Overview

Publisherminihellboy
Repositoryfactorminer
Skill namefactor-report
Stars
123
Forks
38
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by minihellboy on GitHub. Read the source before you install it.

Installation

Install the Factor Report AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/minihellboy/factorminer/tree/main/integrations/factor-researcher/plugin/skills/factor-report
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/minihellboy/factorminer.git /tmp/factorminer
mkdir -p .claude/skills
cp -r /tmp/factorminer/integrations/factor-researcher/plugin/skills/factor-report .claude/skills/factor-report
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Factor Report in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Factor Report on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Factor Report is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Factor Report

This skill turns a finished run into reviewable artifacts: a static report, plots, and portable exports.

Workflow

1. Static report

bash
factorminer report output/run1/factor_library.json \
  --session-log output/run1/session_log.json \
  --format markdown --output output/run1/report.md
  • --format — markdown or html. HTML is self-contained (no JavaScript).
  • --session-log — includes run metadata (iterations, yield rate).
  • --benchmark path.json — fold in benchmark results; repeatable.

The report defines every admission metric inline, lists each factor with its formula and IC/ICIR/correlation, and warns on stale artifacts.

2. Plots

bash
factorminer -o output/run1 visualize output/run1/factor_library.json \
  --data market_data.csv --period test \
  --correlation --ic-timeseries --quintile --format png

3. Export the library

bash
factorminer export output/run1/factor_library.json --format formulas --output output/run1/formulas.txt

--format options: json (full library), csv (tabular metrics), formulas (plain formula list for handoff).

Assembling the research note

A complete note pairs the generated report with narrative the analyst can sign off on:

  1. Objective & data — universe, horizon, split boundaries, validation status.
  2. Method — loop used (Ralph/Helix), features enabled, iteration budget.
  3. Library — admitted factors with formulas and out-of-sample IC/ICIR.
  4. Composite — backtest result net of costs, with the decay caveat.
  5. Benchmark — comparison vs. baselines, if run.
  6. Limitations — overfit risk, capacity, what was not tested.

Guardrails

  • The report presents results; it does not certify them. Frame it as research staged for human review.
  • Quote out-of-sample metrics as the headline; never the in-sample number.
  • Cite the run directory so every figure is reproducible via factorminer session inspect.

Frequently asked questions

What does the Factor Report AI skill do?

Generate static reports, tearsheets, and exports from FactorMiner artifacts — markdown/HTML research notes, plots, and library exports (JSON/CSV/formulas). Use to package a finished research run for review. Triggers on "generate report", "factor report", "research note", "tearsheet", "visualize factors", "export library", "write up the results".

Why use Factor Report on TypingMind?

Because you install it once and use it with any model. Factor Report is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Factor Report in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/minihellboy/factorminer/tree/main/integrations/factor-researcher/plugin/skills/factor-report. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Factor Report?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Factor Report?

As many as you like. As long as a model supports skills, you can use Factor Report with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Factor Report AI skill free?

Yes. It is published on GitHub by minihellboy under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇