Upload README.md with huggingface_hub

README.md

@@ -1,37 +1,51 @@
-# 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)
+---
+language:
+- en
+license: apache-2.0
+library_name: cortexnet
+tags:
+- cortexnet
+- llm
+- state-space-model
+- sparse-attention
+---
+
+# CortexNet
+
+CortexNet is a unified neural architecture implementation for language modeling and reasoning.
+
+This Hugging Face model repository is used as the public project card and release artifact index.
+
+## Install
+
+```bash
+pip install cortexnet
+```
+
+## Quickstart
+
+```python
+import torch
+from cortexnet import CortexNet, CortexNetConfig
+
+cfg = CortexNetConfig(vocab_size=32000, hidden_size=256, num_layers=4, num_heads=8, lite=True)
+model = CortexNet(cfg).eval()
+input_ids = torch.randint(0, cfg.vocab_size, (1, 16))
+with torch.no_grad():
+    out = model(input_ids)
+print(out["logits"].shape)
+```
+
+## Links
+
+- GitHub: https://github.com/chaojixiaokeai/CortexNet
+- PyPI: https://pypi.org/project/cortexnet/
+- GitHub Release: https://github.com/chaojixiaokeai/CortexNet/releases
+- Docs Hub: https://github.com/chaojixiaokeai/CortexNet/tree/main/docs
+
+## Included Files
+
+- `README.md`: this model card
+- `PROJECT_README.md`: project root README
+- `DOCS_INDEX.md`: bilingual docs index
+- `reports/`: release smoke benchmark reports and JSON artifacts