Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.5.2] - 2026-06-22

Documentation, slides, and images only; no library code or public API changes.

### Added

- Introductory slides under `slides/`: `rfscorer_overview_en.pdf` / `rfscorer_overview_ja.pdf`
(distributed under CC BY 4.0), with a new Slides / 紹介スライド section in the README that links
to each PDF via a cover thumbnail. The editable PowerPoint sources
(`rfscorer_overview_en.pptx` / `_ja.pptx`) are kept locally but git-ignored.
- README images:
- `img/slide_cover_en.png` / `img/slide_cover_ja.png`: slide cover thumbnails used in the Slides
section.
- `img/recommendation_system_architecture_using_rfscoring_en.png` / `_ja.png`: a recommendation
system architecture diagram embedded in the README intro.

### Changed

- README overhaul (English and Japanese sections aligned):
- Intro rewritten to explain the **recency** and **frequency** signals individually and to walk
through concrete by-frequency / by-recency / trade-off comparison examples motivating the
optimization-based scoring; added an inline note citing the source paper.
- Features converted from a bullet list to a table and reframed: "Calibration-free" → "Stable
probability estimation", plus new "Downstream use" and "Rich diagnostics & visualization" rows.
- References and Citation sections collapsed into `<details>` toggles.
- Anchor links to the cross-language README lowercased (`#rfscorer` / `#rfscorer-日本語readme`).
- `docs/repository-structure.md`: documented the new `slides/` directory (PDF distribution +
PPTX sources) and expanded the `img/` description to cover the architecture diagrams and slide
thumbnails.
- `.gitignore`: ignore the slide PPTX edit sources (`slides/rfscorer_overview_*.pptx`).

## [0.5.1] - 2026-06-19

Documentation and examples only; no library code or public API changes.
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ For such non-trivial cases, `rfscorer` uses mathematical optimization to estimat

## Slides

📊 [Overview slides (PDF)](https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_en.pdf)(CC BY 4.0)
<a href="https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_en.pdf"><img src="https://raw.githubusercontent.com/jiro-iwanaga/rfscorer/main/img/slide_cover_en.png" width="480"/></a>

[Overview slides (PDF)](https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_en.pdf) (CC BY 4.0)

## Features

Expand Down Expand Up @@ -236,7 +238,9 @@ MIT License

## 紹介スライド

📊 [rfscorer 紹介スライド(PDF・日本語)](https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_ja.pdf)(CC BY 4.0)
<a href="https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_ja.pdf"><img src="https://raw.githubusercontent.com/jiro-iwanaga/rfscorer/main/img/slide_cover_ja.png" width="480"/></a>

[rfscorer 紹介スライド(PDF・日本語)](https://github.com/jiro-iwanaga/rfscorer/blob/main/slides/rfscorer_overview_ja.pdf)(CC BY 4.0)


## パッケージの特徴
Expand Down
16 changes: 14 additions & 2 deletions docs/repository-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ rfscorer/
│ ├── tutorial_practical_ja.ipynb # 実践編チュートリアル(日本語)
│ ├── tutorial_advanced_fit_rolling_en.ipynb # 応用編チュートリアル(英語)
│ └── tutorial_advanced_fit_rolling_ja.ipynb # 応用編チュートリアル(日本語)
├── img/ # README 向け画像
├── img/ # README 向け画像(確率面・構成図・スライドサムネ等)
├── slides/ # 紹介スライド(PDF / PPTX、英語・日本語)
└── docs/ # ドキュメント
├── product-requirements.md # プロダクト要求定義書
├── functional-design.md # 機能仕様書
Expand Down Expand Up @@ -107,7 +108,18 @@ rfscorer/

### `img/`

README.md に埋め込む確率面ワイヤーフレームの画像を配置する。
README.md に埋め込む画像を配置する。確率面ワイヤーフレーム(`surface_*.png`)・推薦システム構成図(`recommendation_system_architecture_using_rfscoring_*.png`)・スライド表紙サムネ(`slide_cover_*.png`)などを含む。

### `slides/`

紹介スライドを配置する。英語版・日本語版それぞれの PDF(README からリンク・サムネイル参照)と、編集元の PPTX を含む。

| パス | 説明 |
|------|------|
| `rfscorer_overview_en.pdf` | 紹介スライド(英語、配布用 PDF) |
| `rfscorer_overview_ja.pdf` | 紹介スライド(日本語、配布用 PDF) |
| `rfscorer_overview_en.pptx` | 紹介スライドの編集元(英語、PowerPoint) |
| `rfscorer_overview_ja.pptx` | 紹介スライドの編集元(日本語、PowerPoint) |

### `docs/`

Expand Down
Binary file added img/slide_cover_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/slide_cover_ja.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "rfscorer"
version = "0.5.1"
version = "0.5.2"
description = "Recency-Frequency based recommendation scoring"
readme = "README.md"
license = { file = "LICENSE" }
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading