Summary

This PR enhances the documentation to make the library more accessible to users, especially those facing environment setup challenges.

Changes

1. README.md Improvements

• Docker Usage Section: Step-by-step guide for Docker setup
  • Build and run container
  • Copy datasets
  • Run zero-shot forecasting examples
• Updated Requirements: Python 3.11 specification
• Project Structure: Detailed directory layout explanation
• Architecture Guide: E2E flow and layer descriptions
• Learning Path: Recommended reading order for newcomers

2. README_zh.md (New)

• Complete Chinese translation of the main README
• Helps Chinese-speaking research community
• Maintains consistency with English documentation
• All sections translated including:
  • Installation guide
  • Usage examples
  • Project structure
  • Architecture explanation

Documentation Highlights

Docker Workflow Example

# Build and start
docker compose up -d --build

# Enter container
docker exec -it tslib bash

# Run zero-shot forecasting
python -u run.py \
  --task_name zero_shot_forecast \
  --model Moirai \
  --data ETTh1 \
  --seq_len 512 \
  --pred_len 96

Project Structure

Added comprehensive directory tree with descriptions for:

• exp/ - Task pipelines
• models/ - Model implementations
• data_provider/ - Dataset loaders
• layers/ - Reusable components
• utils/ - Utility toolbox
• scripts/ - Reproducible experiments

Architecture Overview

Documented the 5-layer architecture:

• E2E flow from scripts to checkpoints
• Experiment layer abstraction
• Model and layer separation
• Data provider patterns
• Utility centralization

Benefits

• ✅ Clearer onboarding for new users
• ✅ Docker workflow documented
• ✅ Better project understanding
• ✅ Accessibility for Chinese researchers
• ✅ Comprehensive learning guidance

Complementary PRs

This documentation enhancement complements:

• feat: Add graceful handling for optional model dependencies #802 - Conditional model imports
• feat: Add Docker support and update dependencies #804 - Docker support and dependencies

Together, these PRs provide a complete solution for easy environment setup and improved developer experience.

Preview

The Chinese README maintains the same quality and completeness as the English version, ensuring consistency across languages.