Skip to content

docs: 优化项目文档和代码注释,提升用户体验#6

Open
zmyybc wants to merge 31 commits intojax_and_zblfrom
lammps
Open

docs: 优化项目文档和代码注释,提升用户体验#6
zmyybc wants to merge 31 commits intojax_and_zblfrom
lammps

Conversation

@zmyybc
Copy link
Copy Markdown
Owner

@zmyybc zmyybc commented Nov 24, 2025

📝 本次更新内容

文档优化

  • 重写 README.md,添加:
    • 项目徽章(arXiv、Python、PyTorch、License)
    • 目录导航
    • 详细的安装指南(分步骤)
    • 快速开始示例
    • 常见问题 FAQ

示例配置

  • 创建 目录:
      • 基础训练配置
      • 高级配置(含 ZBL 势)
      • 微调配置
      • 快速开始脚本

代码优化

  • 为 添加详细 docstring 和中文注释

项目治理

  • 添加 贡献指南
  • 添加 文档索引

✨ 受益

新用户现在可以在 5 分钟内完成安装和训练准备,大幅降低了入门门槛。


由 OpenClaw AI 辅助生成

zmyybc and others added 28 commits November 24, 2025 15:29
Commented out the model load interception logic in hijack_load function.
This document provides a comprehensive guide for installing LAMMPS with the ML-IAP package, including prerequisites, configuration steps, and execution instructions for both single and multi-GPU setups.
Updated README for AlphaNet version 0.1.2-beta with new features and installation instructions.
Added instructions for converting checkpoints and necessary settings for LAMMPS.
Updated README to include new features and installation instructions.
Add instructions for installing dependencies and CuPy.
Removed markdown link formatting from git clone command.
yckbz and others added 2 commits March 23, 2026 13:18
Add neighbor-cache reuse, energy-only inference, and sparse matscipy neighbor lists for ASE-Torch
@zmyybc zmyybc changed the title feat: add lammps interface based on jax_and_zbl docs: 优化项目文档和代码注释,提升用户体验 Apr 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants