Skip to content

docs: Improve documentation and code comments#11

Open
zmyybc wants to merge 32 commits intojax_and_zblfrom
docs/improve-english
Open

docs: Improve documentation and code comments#11
zmyybc wants to merge 32 commits intojax_and_zblfrom
docs/improve-english

Conversation

@zmyybc
Copy link
Copy Markdown
Owner

@zmyybc zmyybc commented Apr 5, 2026

Summary

This PR improves the project documentation and user experience with comprehensive English documentation.

Changes

Documentation

  • Rewrote README.md with:
    • Project badges (arXiv, Python, PyTorch, License)
    • Table of contents navigation
    • Detailed installation guide (step-by-step)
    • Quick start examples
    • FAQ section

Example Configurations

  • Created examples/ directory:
    • config_basic.json - Basic training configuration
    • config_advanced.json - Advanced config with ZBL potential
    • config_finetune.json - Finetuning configuration
    • quickstart.py - Quick start script for new users

Code Improvements

  • Added comprehensive docstrings to train.py

Project Governance

  • Added CONTRIBUTING.md contribution guide
  • Added docs/README.md documentation index

Benefits

New users can now get started within 5 minutes, significantly lowering the barrier to entry.


Auto-generated with OpenClaw AI assistance

bangchenyin and others added 30 commits November 24, 2025 15:25
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.
zmyybc and others added 2 commits March 23, 2026 14:29
Add neighbor-cache reuse, energy-only inference, and sparse matscipy neighbor lists for ASE-Torch
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