Upload README.md with huggingface_hub

README.md

@@ -1,116 +1,37 @@
-# CortexNet
-
-[![CI](https://github.com/chaojixiaokeai/CortexNet/actions/workflows/ci.yml/badge.svg)](https://github.com/chaojixiaokeai/CortexNet/actions/workflows/ci.yml)
-[![PyPI version](https://img.shields.io/pypi/v/cortexnet.svg)](https://pypi.org/project/cortexnet/)
-[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
-
-## Language / 语言
-
-- 中文文档入口: `docs/README.md`（Chinese + English full docs index）
-- English quick docs: `docs/en/QUICKSTART_AND_USAGE.md`
-- Chinese quick docs: `docs/zh-CN/QUICKSTART_AND_USAGE.md`
-
-`CortexNet` 是一个面向语言建模与推理场景的神经网络架构实现，核心思路是将多尺度状态空间建模、选择性稀疏注意力、记忆系统、条件路由与可选高级推理模块组合到同一框架中。
-
-`CortexNet` is a unified neural architecture implementation for language modeling and reasoning, combining multi-scale SSM, selective sparse attention, memory, conditional routing, and optional advanced reasoning modules in one framework.
-
-本仓库已经完成以下整理：
-
-- 统一对外主模型命名为 `CortexNet`（不再以 `*V3` 作为主入口）
-- 代码按 `pip` 可发布标准重构到 `cortexnet/` 包目录
-- 基准/聊天/评测脚本统一归档到 `scripts/`
-- 清理无用导入、冗余变量和缓存文件
-- 补充架构文档和模块映射文档，方便开源协作
-
-## Installation
-
-```bash
-pip install -e .
-```
-
-或构建并安装 wheel：
-
-```bash
-python -m pip install build
-python -m build
-pip install dist/*.whl
-```
-
-## CLI
-
-```bash
-python -m cortexnet --version
-python -m cortexnet --smoke-test
-```
-
-## Quick Start
-
-```python
-import torch
-from cortexnet import CortexNet, CortexNetConfig
-
-config = CortexNetConfig(
-    vocab_size=32000,
-    hidden_size=512,
-    num_layers=4,
-    num_heads=8,
-    max_seq_len=2048,
-)
-
-model = CortexNet(config).eval()
-input_ids = torch.randint(0, config.vocab_size, (1, 16))
-
-with torch.no_grad():
-    out = model(input_ids)
-print(out["logits"].shape)
-```
-
-## Package Layout
-
-```text
-cortexnet/
-  adapter/      # 开源模型识别、权重映射、架构适配、推理适配、校准
-  ops/          # 设备与算子抽象（CPU/CUDA/MPS/NPU/MLU）
-  model.py      # 主模型与 from_pretrained
-  blocks.py     # 核心 block 组合
-  ...
-scripts/
-  benchmarks/   # 性能与量化基准
-  chat/         # 聊天脚本
-  eval/         # 能力评测脚本
-  dev/          # 一键流程与测试运行器
-tests/          # 回归与单元测试
-```
-
-## Test
-
-```bash
-python -m pytest -q
-```
-
-## Docs
-
-- 文档中心（中英文完整文档）：`docs/README.md`
-- 架构说明：`ARCHITECTURE.md`
-- 模块职责图：`MODULE_MAP.md`
-- 变更记录：`CHANGELOG.md`
-- 贡献指南：`CONTRIBUTING.md`
-- 支持与问题分流：`SUPPORT.md`
-- 安全策略：`SECURITY.md`
-- 示例代码：`examples/README.md`
-- 发布基准报告：`docs/reports/README.md`
-- Hugging Face 发布：`docs/en/HF_PUBLISHING.md` / `docs/zh-CN/HF_PUBLISHING.md`
-
-## Compatibility Notes
-
-- 对外推荐只使用 `CortexNet`。
-- 历史命名（如 `CortexNetV2` / `CortexNetV3`）仍保留为兼容别名，避免旧代码立即失效。
-
-## Development Commands
-
-```bash
-make install-dev
-make lint
-make test-all
-make check
-```
+# CortexNet Documentation Hub
+
+This folder contains full documentation for CortexNet in both Chinese and English.
+
+## Chinese (简体中文)
+
+- [技术架构书](./zh-CN/ARCHITECTURE_BOOK.md)
+- [白皮书](./zh-CN/WHITEPAPER.md)
+- [快速开始与使用指南](./zh-CN/QUICKSTART_AND_USAGE.md)
+- [训练与部署手册](./zh-CN/TRAINING_AND_DEPLOYMENT.md)
+- [适配与兼容设计](./zh-CN/ADAPTATION_AND_COMPATIBILITY.md)
+- [基准与评测方法](./zh-CN/BENCHMARKING_AND_EVALUATION.md)
+- [路线图与版本策略](./zh-CN/ROADMAP.md)
+- [开源发布与协作指南](./zh-CN/OPEN_SOURCE_GUIDE.md)
+- [API 参考](./zh-CN/API_REFERENCE.md)
+- [常见问题（FAQ）](./zh-CN/FAQ.md)
+- [架构可视化](./zh-CN/ARCHITECTURE_VISUAL.md)
+- [Hugging Face 发布指南](./zh-CN/HF_PUBLISHING.md)
+
+## English
+
+- [Architecture Book](./en/ARCHITECTURE_BOOK.md)
+- [Whitepaper](./en/WHITEPAPER.md)
+- [Quickstart and Usage](./en/QUICKSTART_AND_USAGE.md)
+- [Training and Deployment](./en/TRAINING_AND_DEPLOYMENT.md)
+- [Adaptation and Compatibility](./en/ADAPTATION_AND_COMPATIBILITY.md)
+- [Benchmarking and Evaluation](./en/BENCHMARKING_AND_EVALUATION.md)
+- [Roadmap and Versioning](./en/ROADMAP.md)
+- [Open Source Collaboration Guide](./en/OPEN_SOURCE_GUIDE.md)
+- [API Reference](./en/API_REFERENCE.md)
+- [FAQ](./en/FAQ.md)
+- [Architecture Visuals](./en/ARCHITECTURE_VISUAL.md)
+- [Hugging Face Publishing Guide](./en/HF_PUBLISHING.md)
+
+## Release Reports
+
+- [Release Benchmark Reports](./reports/README.md)