inventory-lens 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. inventory_lens-0.1.0/.claude-plugin/marketplace.json +16 -0
  2. inventory_lens-0.1.0/.claude-plugin/plugin.json +28 -0
  3. inventory_lens-0.1.0/.github/workflows/ci.yml +22 -0
  4. inventory_lens-0.1.0/.github/workflows/headless-eval.yml +75 -0
  5. inventory_lens-0.1.0/.github/workflows/release.yml +71 -0
  6. inventory_lens-0.1.0/.gitignore +8 -0
  7. inventory_lens-0.1.0/CLAUDE.md +13 -0
  8. inventory_lens-0.1.0/CONTEXT.md +257 -0
  9. inventory_lens-0.1.0/LICENSE +21 -0
  10. inventory_lens-0.1.0/PKG-INFO +168 -0
  11. inventory_lens-0.1.0/README.md +155 -0
  12. inventory_lens-0.1.0/docs/adr/0001-deterministic-computation-llm-interprets.md +8 -0
  13. inventory_lens-0.1.0/docs/adr/0002-mcp-server-engine-host-neutral-interview.md +13 -0
  14. inventory_lens-0.1.0/docs/adr/0003-v1-defaults-target-3pl-operator.md +8 -0
  15. inventory_lens-0.1.0/docs/agents/domain.md +51 -0
  16. inventory_lens-0.1.0/docs/agents/issue-tracker.md +45 -0
  17. inventory_lens-0.1.0/docs/agents/triage-labels.md +15 -0
  18. inventory_lens-0.1.0/docs/research/3pl-defaults.md +257 -0
  19. inventory_lens-0.1.0/pyproject.toml +45 -0
  20. inventory_lens-0.1.0/scripts/check_release_version.py +53 -0
  21. inventory_lens-0.1.0/scripts/release-wizard.sh +298 -0
  22. inventory_lens-0.1.0/skills/discovery/SKILL.md +60 -0
  23. inventory_lens-0.1.0/src/inventory_lens/__init__.py +0 -0
  24. inventory_lens-0.1.0/src/inventory_lens/canonical.py +170 -0
  25. inventory_lens-0.1.0/src/inventory_lens/canonical_model.py +219 -0
  26. inventory_lens-0.1.0/src/inventory_lens/criticality.py +488 -0
  27. inventory_lens-0.1.0/src/inventory_lens/data_issues.py +147 -0
  28. inventory_lens-0.1.0/src/inventory_lens/data_sources.py +151 -0
  29. inventory_lens-0.1.0/src/inventory_lens/defaults/base.yaml +531 -0
  30. inventory_lens-0.1.0/src/inventory_lens/defaults.py +78 -0
  31. inventory_lens-0.1.0/src/inventory_lens/discrepancies.py +71 -0
  32. inventory_lens-0.1.0/src/inventory_lens/errors.py +12 -0
  33. inventory_lens-0.1.0/src/inventory_lens/excel.py +160 -0
  34. inventory_lens-0.1.0/src/inventory_lens/feasibility.py +43 -0
  35. inventory_lens-0.1.0/src/inventory_lens/field_mapping.py +537 -0
  36. inventory_lens-0.1.0/src/inventory_lens/interview.py +317 -0
  37. inventory_lens-0.1.0/src/inventory_lens/landscape.py +113 -0
  38. inventory_lens-0.1.0/src/inventory_lens/levels.py +134 -0
  39. inventory_lens-0.1.0/src/inventory_lens/measurements.py +249 -0
  40. inventory_lens-0.1.0/src/inventory_lens/methods.py +1209 -0
  41. inventory_lens-0.1.0/src/inventory_lens/notice.py +11 -0
  42. inventory_lens-0.1.0/src/inventory_lens/plans.py +759 -0
  43. inventory_lens-0.1.0/src/inventory_lens/policies.py +327 -0
  44. inventory_lens-0.1.0/src/inventory_lens/profiler.py +132 -0
  45. inventory_lens-0.1.0/src/inventory_lens/report.py +499 -0
  46. inventory_lens-0.1.0/src/inventory_lens/segmentation.py +415 -0
  47. inventory_lens-0.1.0/src/inventory_lens/server.py +959 -0
  48. inventory_lens-0.1.0/src/inventory_lens/sql.py +32 -0
  49. inventory_lens-0.1.0/src/inventory_lens/treatments.py +206 -0
  50. inventory_lens-0.1.0/src/inventory_lens/workspace.py +437 -0
  51. inventory_lens-0.1.0/tests/conftest.py +81 -0
  52. inventory_lens-0.1.0/tests/headless_eval/__init__.py +9 -0
  53. inventory_lens-0.1.0/tests/headless_eval/analyst.py +111 -0
  54. inventory_lens-0.1.0/tests/headless_eval/grader.py +234 -0
  55. inventory_lens-0.1.0/tests/headless_eval/organizations/above-supported-scale/expected.yaml +37 -0
  56. inventory_lens-0.1.0/tests/headless_eval/organizations/above-supported-scale/persona_sheet.md +60 -0
  57. inventory_lens-0.1.0/tests/headless_eval/organizations/clean-baseline-3pl/expected.yaml +38 -0
  58. inventory_lens-0.1.0/tests/headless_eval/organizations/clean-baseline-3pl/persona_sheet.md +61 -0
  59. inventory_lens-0.1.0/tests/headless_eval/organizations/criticality-rules/expected.yaml +39 -0
  60. inventory_lens-0.1.0/tests/headless_eval/organizations/criticality-rules/persona_sheet.md +65 -0
  61. inventory_lens-0.1.0/tests/headless_eval/organizations/messy-data/expected.yaml +38 -0
  62. inventory_lens-0.1.0/tests/headless_eval/organizations/messy-data/persona_sheet.md +62 -0
  63. inventory_lens-0.1.0/tests/headless_eval/organizations/multi-site/expected.yaml +38 -0
  64. inventory_lens-0.1.0/tests/headless_eval/organizations/multi-site/persona_sheet.md +60 -0
  65. inventory_lens-0.1.0/tests/headless_eval/organizations/no-order-references/expected.yaml +40 -0
  66. inventory_lens-0.1.0/tests/headless_eval/organizations/no-order-references/persona_sheet.md +63 -0
  67. inventory_lens-0.1.0/tests/headless_eval/organizations/no-prices/expected.yaml +40 -0
  68. inventory_lens-0.1.0/tests/headless_eval/organizations/no-prices/persona_sheet.md +62 -0
  69. inventory_lens-0.1.0/tests/headless_eval/organizations/shared-item-codes/expected.yaml +38 -0
  70. inventory_lens-0.1.0/tests/headless_eval/organizations/shared-item-codes/persona_sheet.md +60 -0
  71. inventory_lens-0.1.0/tests/headless_eval/organizations/short-history/expected.yaml +40 -0
  72. inventory_lens-0.1.0/tests/headless_eval/organizations/short-history/persona_sheet.md +66 -0
  73. inventory_lens-0.1.0/tests/headless_eval/organizations/small-hand-checked/expected.yaml +38 -0
  74. inventory_lens-0.1.0/tests/headless_eval/organizations/small-hand-checked/persona_sheet.md +57 -0
  75. inventory_lens-0.1.0/tests/headless_eval/organizations/vietnamese-headers/expected.yaml +38 -0
  76. inventory_lens-0.1.0/tests/headless_eval/organizations/vietnamese-headers/persona_sheet.md +66 -0
  77. inventory_lens-0.1.0/tests/headless_eval/plugin.py +143 -0
  78. inventory_lens-0.1.0/tests/headless_eval/report.py +111 -0
  79. inventory_lens-0.1.0/tests/headless_eval/runner.py +156 -0
  80. inventory_lens-0.1.0/tests/headless_eval/sheets.py +168 -0
  81. inventory_lens-0.1.0/tests/run_headless_eval.py +96 -0
  82. inventory_lens-0.1.0/tests/synthetic/__init__.py +736 -0
  83. inventory_lens-0.1.0/tests/test_abc_bases_hml.py +597 -0
  84. inventory_lens-0.1.0/tests/test_class_policies.py +435 -0
  85. inventory_lens-0.1.0/tests/test_data_sources.py +87 -0
  86. inventory_lens-0.1.0/tests/test_data_treatments.py +668 -0
  87. inventory_lens-0.1.0/tests/test_defaults.py +132 -0
  88. inventory_lens-0.1.0/tests/test_discovery_report.py +298 -0
  89. inventory_lens-0.1.0/tests/test_discrepancies.py +346 -0
  90. inventory_lens-0.1.0/tests/test_field_mapping.py +513 -0
  91. inventory_lens-0.1.0/tests/test_formats.py +235 -0
  92. inventory_lens-0.1.0/tests/test_headless_eval.py +258 -0
  93. inventory_lens-0.1.0/tests/test_interview.py +422 -0
  94. inventory_lens-0.1.0/tests/test_llm_log.py +41 -0
  95. inventory_lens-0.1.0/tests/test_plan_editing.py +815 -0
  96. inventory_lens-0.1.0/tests/test_plugin_instructions.py +128 -0
  97. inventory_lens-0.1.0/tests/test_plugin_packaging.py +86 -0
  98. inventory_lens-0.1.0/tests/test_profiling.py +112 -0
  99. inventory_lens-0.1.0/tests/test_readme.py +16 -0
  100. inventory_lens-0.1.0/tests/test_release.py +117 -0
  101. inventory_lens-0.1.0/tests/test_run_history.py +276 -0
  102. inventory_lens-0.1.0/tests/test_scale.py +141 -0
  103. inventory_lens-0.1.0/tests/test_segmentation.py +493 -0
  104. inventory_lens-0.1.0/tests/test_segmentation_levels.py +686 -0
  105. inventory_lens-0.1.0/tests/test_synthetic_organizations.py +60 -0
  106. inventory_lens-0.1.0/tests/test_ved.py +823 -0
  107. inventory_lens-0.1.0/tests/test_workspace.py +37 -0
  108. inventory_lens-0.1.0/tests/test_xyz_fsn_combined.py +490 -0
  109. inventory_lens-0.1.0/uv.lock +1243 -0
@@ -0,0 +1,16 @@
1
+ {
2
+ "name": "inventory-lens",
3
+ "owner": {
4
+ "name": "ducdeb3rry"
5
+ },
6
+ "description": "Inventory Lens, as an installable Claude Code plugin.",
7
+ "plugins": [
8
+ {
9
+ "name": "inventory-lens",
10
+ "source": "./",
11
+ "description": "An inventory-segmentation consultant for 3PL Analysts, backed by a deterministic MCP engine.",
12
+ "category": "data",
13
+ "keywords": ["inventory", "segmentation", "3pl", "warehouse"]
14
+ }
15
+ ]
16
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "name": "inventory-lens",
3
+ "version": "0.1.0",
4
+ "description": "An inventory-segmentation consultant for 3PL Analysts: profiles your WMS exports with a deterministic engine and guides you through Discovery.",
5
+ "author": {
6
+ "name": "ducdeb3rry"
7
+ },
8
+ "repository": "https://github.com/ducdeb3rry/inventory-lens",
9
+ "license": "MIT",
10
+ "keywords": [
11
+ "inventory",
12
+ "segmentation",
13
+ "3pl",
14
+ "warehouse",
15
+ "abc-analysis",
16
+ "mcp"
17
+ ],
18
+ "mcpServers": {
19
+ "inventory-lens": {
20
+ "command": "uvx",
21
+ "args": [
22
+ "--from",
23
+ "inventory-lens==0.1.0",
24
+ "inventory-lens-mcp"
25
+ ]
26
+ }
27
+ }
28
+ }
@@ -0,0 +1,22 @@
1
+ name: CI
2
+
3
+ on:
4
+ pull_request:
5
+ push:
6
+ branches: [main]
7
+
8
+ jobs:
9
+ seam-1:
10
+ name: Typecheck, Seam 1 and packaging tests
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v4
14
+ - uses: astral-sh/setup-uv@v6
15
+ with:
16
+ python-version: "3.12"
17
+ - run: uv sync --locked
18
+ - run: uv run mypy
19
+ - name: Seam 1
20
+ run: uv run pytest -m "not packaging"
21
+ - name: Plugin launches the engine
22
+ run: uv run pytest -m packaging
@@ -0,0 +1,75 @@
1
+ name: Headless Interview eval
2
+
3
+ # Seam 2: runs the real plugin headless against the Synthetic Organizations, with a
4
+ # simulated Analyst. On demand only; it spends the Claude subscription's usage and Gemini
5
+ # API usage, so it never runs on pull requests.
6
+ on:
7
+ workflow_dispatch:
8
+ inputs:
9
+ organizations:
10
+ description: "Space-separated organizations to run (ignored when 'all' is set)"
11
+ default: short-history
12
+ all:
13
+ description: Run every Synthetic Organization, one at a time
14
+ type: boolean
15
+ default: false
16
+ plugin_model:
17
+ description: The plugin's model (empty for the pinned default)
18
+ default: ""
19
+ analyst_model:
20
+ description: The simulated Analyst's Gemini model (empty for the pinned default)
21
+ default: ""
22
+ max_analyst_turns:
23
+ description: Analyst messages per organization before stopping
24
+ default: "40"
25
+ timeout_minutes:
26
+ description: Wall-clock cap per organization, in minutes
27
+ default: "90"
28
+ # Nightly, once the eval is stable enough to be worth its usage:
29
+ # schedule:
30
+ # - cron: "17 19 * * *"
31
+
32
+ jobs:
33
+ headless-eval:
34
+ name: Headless Interview eval
35
+ runs-on: ubuntu-latest
36
+ timeout-minutes: 360
37
+ steps:
38
+ - uses: actions/checkout@v4
39
+ - uses: astral-sh/setup-uv@v6
40
+ with:
41
+ python-version: "3.12"
42
+ - uses: actions/setup-node@v4
43
+ with:
44
+ node-version: "22"
45
+ - run: npm install -g @anthropic-ai/claude-code@2.1.329
46
+ - run: uv sync --locked
47
+ - name: Run the eval
48
+ env:
49
+ INVENTORY_LENS_EVAL_CLAUDE_OAUTH_TOKEN: ${{ secrets.INVENTORY_LENS_EVAL_CLAUDE_OAUTH_TOKEN }}
50
+ INVENTORY_LENS_EVAL_GEMINI_API_KEY: ${{ secrets.INVENTORY_LENS_EVAL_GEMINI_API_KEY }}
51
+ INVENTORY_LENS_EVAL_PLUGIN_MODEL: ${{ inputs.plugin_model }}
52
+ INVENTORY_LENS_EVAL_ANALYST_MODEL: ${{ inputs.analyst_model }}
53
+ ORGANIZATIONS: ${{ inputs.organizations }}
54
+ ALL: ${{ inputs.all }}
55
+ MAX_ANALYST_TURNS: ${{ inputs.max_analyst_turns }}
56
+ TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
57
+ run: |
58
+ if [ "$ALL" = "true" ]; then
59
+ which=(--all)
60
+ else
61
+ which=()
62
+ for organization in $ORGANIZATIONS; do which+=(--org "$organization"); done
63
+ fi
64
+ uv run python tests/run_headless_eval.py "${which[@]}" \
65
+ --max-analyst-turns "$MAX_ANALYST_TURNS" --timeout-minutes "$TIMEOUT_MINUTES" \
66
+ --out eval-runs | tee -a "$GITHUB_STEP_SUMMARY"
67
+ - name: Keep the transcripts and Workspaces
68
+ if: always()
69
+ uses: actions/upload-artifact@v4
70
+ with:
71
+ name: headless-eval
72
+ path: |
73
+ eval-runs/
74
+ !eval-runs/**/home/
75
+ if-no-files-found: ignore
@@ -0,0 +1,71 @@
1
+ name: Release
2
+
3
+ # Publishes a tagged version: pushing the tag v<version> builds the engine, publishes it to
4
+ # PyPI through Trusted Publishing (no stored token) and creates the GitHub Release. It never
5
+ # runs on pull requests. The one-time setup is a human job: scripts/release-wizard.sh.
6
+ on:
7
+ push:
8
+ tags: ["v*"]
9
+
10
+ permissions:
11
+ contents: read
12
+
13
+ jobs:
14
+ build:
15
+ name: Check, gate and build
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+ - uses: astral-sh/setup-uv@v6
20
+ with:
21
+ python-version: "3.12"
22
+ - name: The tag, pyproject.toml, uv.lock and the plugin carry one version
23
+ run: python3 scripts/check_release_version.py --tag "$GITHUB_REF_NAME"
24
+ - run: uv sync --locked
25
+ - run: uv run mypy
26
+ - name: Seam 1
27
+ run: uv run pytest -m "not packaging"
28
+ - name: Plugin launches the engine
29
+ run: uv run pytest -m packaging
30
+ - run: uv build
31
+ - name: The metadata is one PyPI accepts (fails here, before the publish job)
32
+ run: uvx --from twine==7.0.0 twine check --strict dist/*
33
+ - uses: actions/upload-artifact@v4
34
+ with:
35
+ name: dist
36
+ path: dist/
37
+ if-no-files-found: error
38
+
39
+ publish:
40
+ name: Publish to PyPI
41
+ needs: build
42
+ runs-on: ubuntu-latest
43
+ # The environment is where PyPI's Trusted Publisher trusts this workflow; add required
44
+ # reviewers to it in the repository settings to hold a release for approval.
45
+ environment:
46
+ name: pypi
47
+ url: https://pypi.org/project/inventory-lens/
48
+ permissions:
49
+ id-token: write
50
+ steps:
51
+ - uses: actions/download-artifact@v4
52
+ with:
53
+ name: dist
54
+ path: dist/
55
+ - uses: pypa/gh-action-pypi-publish@v1.14.3
56
+
57
+ github-release:
58
+ name: GitHub Release
59
+ needs: publish
60
+ runs-on: ubuntu-latest
61
+ permissions:
62
+ contents: write
63
+ steps:
64
+ - uses: actions/download-artifact@v4
65
+ with:
66
+ name: dist
67
+ path: dist/
68
+ - name: Create the release
69
+ env:
70
+ GH_TOKEN: ${{ github.token }}
71
+ run: gh release create "$GITHUB_REF_NAME" dist/* --repo "$GITHUB_REPOSITORY" --verify-tag --title "$GITHUB_REF_NAME" --generate-notes
@@ -0,0 +1,8 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.py[cod]
4
+ .pytest_cache/
5
+ .mypy_cache/
6
+ dist/
7
+ build/
8
+ eval-runs/
@@ -0,0 +1,13 @@
1
+ ## Agent skills
2
+
3
+ ### Issue tracker
4
+
5
+ Issues are tracked in GitHub Issues via the `gh` CLI. See `docs/agents/issue-tracker.md`.
6
+
7
+ ### Triage labels
8
+
9
+ Default five-label vocabulary (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See `docs/agents/triage-labels.md`.
10
+
11
+ ### Domain docs
12
+
13
+ Single-context: one `CONTEXT.md` and `docs/adr/` at the repo root. See `docs/agents/domain.md`.
@@ -0,0 +1,257 @@
1
+ # Inventory Lens
2
+
3
+ An AI consultant that works out what inventory data an organization has, what it wants from that data, and which inventory segmentation approaches are feasible and suitable for it.
4
+
5
+ ## People
6
+
7
+ **Analyst**:
8
+ The person using Inventory Lens: a supply-chain, inventory or finance practitioner who knows the business domain but is not expected to know statistics or data science.
9
+ _Avoid_: User, customer, operator
10
+
11
+ **Client**:
12
+ The company that owns the stock a 3PL operator holds and handles on its behalf.
13
+ _Avoid_: Owner, depositor, customer
14
+
15
+ ## Discovery
16
+
17
+ **Discovery**:
18
+ The whole process by which Inventory Lens comes to understand an organization's data and goals, covering Profiling, the Interview, and Confirmation.
19
+ _Avoid_: Onboarding, assessment, intake
20
+
21
+ **Workspace**:
22
+ The folder in the Analyst's project that holds everything Discovery and Segmentation Runs produce for one organization.
23
+ _Avoid_: Project, session, store
24
+
25
+ **Data Source**:
26
+ A file or connection the Analyst points Inventory Lens at, which holds inventory-related data such as item master data or transaction history.
27
+ _Avoid_: Dataset, input, feed
28
+
29
+ **Canonical Model**:
30
+ The fixed shape every Data Source is mapped into: an Item Master, Movements, and optional Stock Snapshots and Locations.
31
+ _Avoid_: Schema, data model, standard format
32
+
33
+ **Item Master**:
34
+ The list of Items with their descriptive attributes, such as code, description, category and unit cost.
35
+ _Avoid_: Product master, material master, catalogue
36
+
37
+ **Movement**:
38
+ One recorded quantity of an Item moving on a date, with its Movement Type and, where known, the order and line it belongs to.
39
+ _Avoid_: Transaction, event, line
40
+
41
+ **Movement Type**:
42
+ What kind of Movement it is: receipt, pick, internal move, adjustment or return. Only picks count as demand by default.
43
+ _Avoid_: Transaction type, reason code
44
+
45
+ **Hit**:
46
+ One order line picked for an Item, regardless of quantity.
47
+ _Avoid_: Pick, visit, line count
48
+
49
+ **Handling Attribute**:
50
+ A physical or regulatory property of an Item that limits where and how it may be stored, such as hazardous, temperature-controlled or high-security.
51
+ _Avoid_: Criticality, storage class
52
+
53
+ **Unit of Measure**:
54
+ The unit an Item's quantities are counted in, such as each, inner or case. Units picked are only comparable across Items counted in the same Unit of Measure.
55
+ _Avoid_: UoM, pack, unit
56
+
57
+ **Cube**:
58
+ The space one unit of an Item takes up, worked out from its dimensions.
59
+ _Avoid_: Volume, size
60
+
61
+ **Stock Snapshot**:
62
+ The quantity of an Item on hand at a location on a given date.
63
+ _Avoid_: Inventory level, balance, on-hand report
64
+
65
+ **Site**:
66
+ A warehouse, distribution center or store where Items are held, as a Movement names it. A Site is never a bin or slot inside it: that is a Location.
67
+ _Avoid_: Facility, plant, node, depot
68
+
69
+ **Location**:
70
+ A storage position inside a Site, such as a bin or slot, where an Item's stock is put away or picked. A Location is never a Site, so it never identifies a Stocking Point.
71
+ _Avoid_: Bin, slot, position
72
+
73
+ **Field Mapping**:
74
+ Which column of which Data Source supplies each field of the Canonical Model. Inventory Lens proposes it and the Analyst confirms it.
75
+ _Avoid_: Column mapping, schema mapping
76
+
77
+ **Profiling**:
78
+ Inventory Lens inspecting Data Sources directly to infer their structure, content and quality, before asking the Analyst anything.
79
+ _Avoid_: Scanning, data audit
80
+
81
+ **Target KPI**:
82
+ An inventory performance indicator the Analyst cares about, such as turnover or fill rate, captured in the Interview to shape the Segmentation Plan. Inventory Lens does not compute it.
83
+ _Avoid_: Metric, goal
84
+
85
+ **Interview**:
86
+ The questions Inventory Lens asks the Analyst about what Profiling cannot infer, such as business objectives, constraints and preferences.
87
+ _Avoid_: Questionnaire, survey, chat
88
+
89
+ **Interview Topic**:
90
+ One area the Interview must cover, such as objectives, operating model or criticality. Each is marked covered, inferred from data, or not applicable before Discovery is complete.
91
+ _Avoid_: Question, section, step
92
+
93
+ **Discrepancy**:
94
+ A conflict between what Profiling measured and what the Analyst stated, for example about how much history exists. The measured value is used, and the Analyst is shown the Discrepancy and asked to check it and confirm.
95
+ _Avoid_: Conflict, mismatch, inconsistency
96
+
97
+ **Confirmation**:
98
+ The Analyst explicitly agreeing, or correcting, what Inventory Lens has inferred about their data and situation.
99
+ _Avoid_: Validation, approval, sign-off
100
+
101
+ **Data Landscape**:
102
+ Inventory Lens's confirmed understanding of what data an organization has, how it is structured, and how complete and reliable it is.
103
+ _Avoid_: Data inventory, data map, schema
104
+
105
+ **Measure**:
106
+ One quantity Inventory Lens computes from the data through the confirmed Field Mapping, such as the days of history or the number of Clients. Only measured values count, never what the Analyst stated.
107
+ _Avoid_: Metric, statistic, figure, KPI
108
+
109
+ **Data Landscape Summary**:
110
+ The Data Landscape as measured: each mapped part of the Canonical Model with its Data Source, and each Measure with its value. It is what the Analyst confirms and what Discrepancies are checked against.
111
+ _Avoid_: Profile, overview, data report
112
+
113
+ **Discovery Report**:
114
+ The deliverable of Discovery: the Data Landscape, an assessment of data quality, which Segmentation Methods are feasible, and which are recommended.
115
+ _Avoid_: Assessment report, findings, summary
116
+
117
+ ## Segmentation
118
+
119
+ **Item**:
120
+ A distinct stocked product, identified by its Client together with its item code, across all Sites and Locations.
121
+ _Avoid_: SKU, product, material, part
122
+
123
+ **Stocking Point**:
124
+ An Item held at one Site, such as a warehouse or store, identified by its Client, its item code and the Site.
125
+ _Avoid_: SKU-location, item-location, node
126
+
127
+ **Segmentation Level**:
128
+ What a Segmentation Run classes and across what scope: Items warehouse-wide (every Item against all the others), Items within each Client (each Client's Items against each other), or Stocking Points (each Site's Stocking Points against each other). It is chosen in the Segmentation Plan, with Items warehouse-wide as the default.
129
+ _Avoid_: Granularity, grain
130
+
131
+ **Method Requirements**:
132
+ The data a Segmentation Method needs in order to be applied, such as required fields and minimum history.
133
+ _Avoid_: Prerequisites, preconditions
134
+
135
+ **Feasibility Verdict**:
136
+ Whether the Data Landscape meets a Segmentation Method's Method Requirements: Feasible, Feasible with Caveats, or Infeasible with a stated reason. The Analyst may override an Infeasible verdict, and the Override is recorded in the Segmentation Plan.
137
+ _Avoid_: Eligibility, readiness score
138
+
139
+ **Override**:
140
+ The Analyst's decision, recorded in the Segmentation Plan with their reason, to apply a Segmentation Method despite an Infeasible Feasibility Verdict. It holds only while the method is Infeasible for the reason that was overridden.
141
+ _Avoid_: Exception, waiver, bypass, force
142
+
143
+ **Segmentation Method**:
144
+ A rule for sorting items into classes along one dimension. The supported methods are ABC, XYZ, VED, FSN and HML.
145
+ _Avoid_: Technique, algorithm, model
146
+
147
+ **ABC**:
148
+ A Segmentation Method that classes items by their share of the total on the ABC Basis, such as their share of all units picked.
149
+
150
+ **ABC Basis**:
151
+ The measure ABC ranks items by: units picked (the default), Hits, cube moved, or value.
152
+ _Avoid_: ABC criterion, ranking metric
153
+
154
+ **XYZ**:
155
+ A Segmentation Method that classes items by how variable their demand is.
156
+
157
+ **VED**:
158
+ A Segmentation Method that classes items as Vital, Essential or Desirable by how critical they are to the Client's service commitments.
159
+
160
+ **Criticality Rule**:
161
+ A rule, captured in the Interview, that gives a VED class to every item matching a condition (for example, "all Safety items are Vital").
162
+
163
+ **FSN**:
164
+ A Segmentation Method that classes items as Fast-, Slow- or Non-moving by how often they move.
165
+
166
+ **HML**:
167
+ A Segmentation Method that classes items as High, Medium or Low by unit price.
168
+
169
+ **Combined Segmentation**:
170
+ Two or more Segmentation Methods applied together so that each item gets a joint class, such as ABC-XYZ's "AX".
171
+ _Avoid_: Matrix, cross-classification, multi-criteria segmentation
172
+
173
+ **Cut-off**:
174
+ A boundary value that separates one class from the next in a Segmentation Method or Lifecycle Class, such as 80% of cumulative units picked for ABC A, or a coefficient of variation of 0.5 for XYZ X.
175
+ _Avoid_: Threshold, breakpoint, limit
176
+
177
+ **Look-back Window**:
178
+ The span of the most recent history a Segmentation Method considers, such as the last 26 weeks for FSN.
179
+ _Avoid_: Window, horizon, history period
180
+
181
+ **Demand Period**:
182
+ The length of time demand is grouped into, such as a week, when measuring how much an Item's demand varies.
183
+ _Avoid_: Bucket, time grain, interval
184
+
185
+ **Defaults**:
186
+ The versioned, source-cited starting values Inventory Lens uses for method parameters, Method Requirements, Data Treatments and the Policy Library. Each Segmentation Plan records which version of the Defaults it was built from.
187
+ _Avoid_: Settings, presets, config
188
+
189
+ **Data Treatment**:
190
+ A stated rule in the Segmentation Plan for handling one kind of data issue, such as returns, negative quantities, outliers or internal transfers.
191
+ _Avoid_: Cleaning, preprocessing, fix
192
+
193
+ **Lifecycle Class**:
194
+ A class, New or Obsolete, given to Items whose history is too short or has stopped, which keeps them out of methods that would misclassify them.
195
+ _Avoid_: Pseudo-class, exclusion, status
196
+
197
+ **Segmentation Plan**:
198
+ The editable record of which Segmentation Methods and Combined Segmentations to apply and with which parameters, each with the reasoning behind it. Inventory Lens proposes it from Discovery; the Analyst may change it.
199
+ _Avoid_: Settings, configuration, preferences
200
+
201
+ **Left-out Method**:
202
+ A Segmentation Method the Segmentation Plan does not apply, recorded with who left it out: Inventory Lens, because it is Infeasible, or the Analyst, whose reason stands whatever its Feasibility Verdict becomes.
203
+ _Avoid_: Excluded method, disabled method, dropped method
204
+
205
+ **Segmentation Run**:
206
+ Applying a Segmentation Plan to the data to give each item its class. It happens only when the Analyst explicitly asks for it. Every Segmentation Run is kept, together with the plan it used and a fingerprint of the Data Sources.
207
+ _Avoid_: Analysis, execution, job
208
+
209
+ **Stale Plan**:
210
+ A Segmentation Plan whose Data Sources have changed since it was proposed, so it needs Profiling again before the next Segmentation Run.
211
+ _Avoid_: Outdated plan, invalid plan
212
+
213
+ **Class Summary**:
214
+ Per-class counts and value shares produced by a Segmentation Run, including grids for Combined Segmentations.
215
+ _Avoid_: Dashboard, overview
216
+
217
+ **Class Policy**:
218
+ A recommended way to handle the Items in one class: their Storage Zone, Cycle Count frequency, Pick-Face Replenishment approach, and review of slow and non-moving stock.
219
+ _Avoid_: Strategy, rule, playbook
220
+
221
+ **Storage Zone**:
222
+ A band of storage locations ranked by how fast they are to pick from: golden, standard or reserve.
223
+ _Avoid_: Slot class, area, aisle
224
+
225
+ **Pick Face**:
226
+ The location an Item is picked from, holding a small amount of stock refilled from reserve. It is fixed when kept for one Item, or dynamic when assigned to an Item only while it needs one.
227
+ _Avoid_: Pick location, forward location, pick slot
228
+
229
+ **Pick-Face Replenishment**:
230
+ Moving stock from reserve to an Item's Pick Face so that picks find enough there. It is internal to the warehouse, not the Client buying more stock.
231
+ _Avoid_: Restock, top-up, replenishment
232
+
233
+ **Cycle Count**:
234
+ Counting the stock of some Items at their locations on a rolling schedule, rather than counting the whole warehouse at once.
235
+ _Avoid_: Stocktake, physical inventory, audit
236
+
237
+ **Short Pick**:
238
+ A pick that finds less stock at the Pick Face than the stock records show.
239
+ _Avoid_: Stock-out, mis-pick
240
+
241
+ **Policy Library**:
242
+ The curated default Class Policies that Inventory Lens ships with in the Defaults: one per class, and a rule for putting a Combined Segmentation cell's policy together from the policies of the classes it joins.
243
+ _Avoid_: Playbook, rulebook
244
+
245
+ **Advice**:
246
+ Context-specific guidance the LLM adds to a Class Policy, always labelled as Advice and never containing policy numbers.
247
+ _Avoid_: Insight, recommendation, tip
248
+
249
+ ## Quality
250
+
251
+ **Synthetic Organization**:
252
+ A generated set of Data Sources with known characteristics, plus the Feasibility Verdicts and Segmentation Plan expected for it.
253
+ _Avoid_: Fixture, test dataset, sample data
254
+
255
+ **Persona Sheet**:
256
+ A description of a simulated Analyst and their organization, used to answer Interview questions consistently during evaluation.
257
+ _Avoid_: Script, character, user profile
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 ducdeb3rry
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.