jiajun commited on
Upload CHANGELOG.md with huggingface_hub
Browse files- CHANGELOG.md +83 -0
CHANGELOG.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Changelog
|
| 2 |
+
|
| 3 |
+
All notable changes to this project are documented in this file.
|
| 4 |
+
|
| 5 |
+
## 3.2.5 - 2026-02-26
|
| 6 |
+
|
| 7 |
+
### Added
|
| 8 |
+
|
| 9 |
+
- Added Hugging Face publishing workflow: `.github/workflows/publish_hf.yml`.
|
| 10 |
+
- Added Hugging Face publishing script and templates:
|
| 11 |
+
- `scripts/release/publish_hf_assets.py`
|
| 12 |
+
- `deploy/hf_space/*`
|
| 13 |
+
- `hf/model_card/README.md`
|
| 14 |
+
- Added bilingual Hugging Face publishing docs:
|
| 15 |
+
- `docs/en/HF_PUBLISHING.md`
|
| 16 |
+
- `docs/zh-CN/HF_PUBLISHING.md`
|
| 17 |
+
|
| 18 |
+
### Changed
|
| 19 |
+
|
| 20 |
+
- PyPI publish workflow now tries Trusted Publishing (OIDC) first and falls back to token.
|
| 21 |
+
- Release guide now documents Trusted Publishing setup URL and HF token usage.
|
| 22 |
+
- Added `examples-smoke` and `report-smoke` Make targets.
|
| 23 |
+
|
| 24 |
+
## 3.2.4 - 2026-02-26
|
| 25 |
+
|
| 26 |
+
### Added
|
| 27 |
+
|
| 28 |
+
- Added release smoke benchmark script: `scripts/benchmarks/benchmark_release_smoke.py`.
|
| 29 |
+
- Added fixed benchmark report hub and artifacts folder under `docs/reports/`.
|
| 30 |
+
- Added bilingual architecture entry and release report links in docs index.
|
| 31 |
+
|
| 32 |
+
### Changed
|
| 33 |
+
|
| 34 |
+
- README upgraded with bilingual landing section (Chinese + English quick entry).
|
| 35 |
+
- CI/Makefile now include `examples/` in static checks.
|
| 36 |
+
- CI test job now runs example smoke scripts.
|
| 37 |
+
|
| 38 |
+
## 3.2.3 - 2026-02-26
|
| 39 |
+
|
| 40 |
+
### Added
|
| 41 |
+
|
| 42 |
+
- Added `SUPPORT.md` for issue routing and maintainer response expectations.
|
| 43 |
+
- Added bilingual FAQ docs (`docs/zh-CN/FAQ.md`, `docs/en/FAQ.md`).
|
| 44 |
+
- Added bilingual architecture visual docs with Mermaid flows (`docs/zh-CN/ARCHITECTURE_VISUAL.md`, `docs/en/ARCHITECTURE_VISUAL.md`).
|
| 45 |
+
- Added runnable examples under `examples/` for minimal inference, migration loading, and tiny training.
|
| 46 |
+
|
| 47 |
+
### Changed
|
| 48 |
+
|
| 49 |
+
- Expanded docs index and root README navigation to include support and examples.
|
| 50 |
+
- Upgraded release guide with GitHub Actions-first publish flow and failure recovery notes.
|
| 51 |
+
|
| 52 |
+
## 3.2.2 - 2026-02-26
|
| 53 |
+
|
| 54 |
+
### Changed
|
| 55 |
+
|
| 56 |
+
- Release workflow now uses `skip-existing: true` to make manual/duplicate publish runs idempotent.
|
| 57 |
+
- CI compatibility improved for Python 3.9 type annotations and current legacy code style checks.
|
| 58 |
+
|
| 59 |
+
## 3.2.1 - 2026-02-27
|
| 60 |
+
|
| 61 |
+
### Added
|
| 62 |
+
|
| 63 |
+
- Standard package layout under `cortexnet/`
|
| 64 |
+
- Open-source docs: `README.md`, `ARCHITECTURE.md`, `MODULE_MAP.md`
|
| 65 |
+
- Full bilingual documentation hub under `docs/` (architecture book, whitepaper, quickstart, training/deployment, compatibility, benchmarking, roadmap, API reference, open-source guide)
|
| 66 |
+
- Governance docs: `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`
|
| 67 |
+
- GitHub templates and workflows for CI and publishing
|
| 68 |
+
- Security/dependency automation: `codeql.yml`, `dependabot.yml`
|
| 69 |
+
- Developer productivity files: `.pre-commit-config.yaml`, `.editorconfig`, `Makefile`
|
| 70 |
+
- Public CLI entrypoint: `python -m cortexnet` / `cortexnet` command
|
| 71 |
+
- Public API contract tests: `tests/test_public_api.py`
|
| 72 |
+
|
| 73 |
+
### Changed
|
| 74 |
+
|
| 75 |
+
- Unified public model name to `CortexNet`
|
| 76 |
+
- Reorganized scripts under `scripts/benchmarks`, `scripts/chat`, `scripts/eval`, `scripts/dev`
|
| 77 |
+
- Improved `pyproject.toml` metadata and packaging backend
|
| 78 |
+
|
| 79 |
+
### Fixed
|
| 80 |
+
|
| 81 |
+
- Cleaned unused imports/variables and stale script paths
|
| 82 |
+
- Aligned script-level run tests with current config defaults
|
| 83 |
+
- Ensured full test/build/install verification pipeline passes
|