Feature ci, 3rd party framework, requirements (#8)

* [feature]: add requirements, update readme

* [feature]: add 3rd party placeholder

* [feature]: add lint ci

.github/workflows/lint.yml

+name: lint
+
+on:
+  pull_request:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Cache Python dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install pre-commit hook
+        run: |
+          pip install pre-commit ruff
+
+      - name: Check pre-commit config file
+        run: |
+          if [ ! -f ".pre-commit-config.yaml" ]; then
+            echo "Error: .pre-commit-config.yaml not found."
+            exit 1
+          fi
+
+      - name: Linting
+        run: |
+          echo "Running pre-commit on all files..."
+          pre-commit run --all-files || {
+            echo "Linting failed. Please check the above output for details."
+            exit 1
+          }

README.md

@@ -8,21 +8,28 @@
 
 --------------------------------------------------------------------------------
 
-## Prepare Environment
+## Fast Start Up
 
 ```shell
-docker pull registry.cn-sh-01.sensecore.cn/devsft-ccr-2/video-gen:25033101
-docker run --gpus all -itd --ipc=host --name [name] -v /mnt:/mnt --entrypoint /bin/bash [image id]
+git clone https://github.com/ModelTC/lightx2v.git lightx2v && cd lightx2v
+
+conda create -n lightx2v python=3.11 && conda activate lightx2v
+pip install -r requirements.txt
+
+# download flash attention and install
+git clone https://github.com/Dao-AILab/flash-attention.git --recursive
+cd flash-attention && pip install -v -e .
+# for FA3, cd flash-attention/hopper && pip install -v -e .
+
+# modify the parameters of the running script
+bash scripts/run_hunyuan_t2v.sh
 ```
 
-## Fast Start
+## Docker Image
 
 ```shell
-git clone https://github.com/ModelTC/lightx2v.git
-cd lightx2v
-
-# Modify the parameters of the running script
-bash run_hunyuan_t2v.sh
+docker pull registry.cn-sh-01.sensecore.cn/devsft-ccr-2/video-gen:25033101
+docker run --gpus all -itd --ipc=host --name [name] -v /mnt:/mnt --entrypoint /bin/bash [image id]
 ```
 
 ## Contribute
@@ -35,7 +42,7 @@ We have prepared a `pre-commit` hook to enforce consistent code formatting acros
     pip install ruff pre-commit
 ```
 
-2. Then, run the following command:
+2. Then, run the following command before commit:
 
 ```shell
     pre-commit run --all-files

requirements.txt

+accelerate==1.6.0
+aiohappyeyeballs==2.6.1
+aiohttp==3.11.16
+aiosignal==1.3.2
+airportsdata==20250224
+annotated-types==0.7.0
+anyio==4.9.0
+astor==0.8.1
+attrs==25.3.0
+autocommand==2.2.2
+backports.tarfile==1.2.0
+blake3==1.0.4
+cachetools==5.5.2
+certifi==2025.1.31
+charset-normalizer==3.4.1
+click==8.1.8
+cloudpickle==3.1.1
+compressed-tensors==0.9.2
+cupy-cuda12x==13.4.1
+depyf==0.18.0
+diffusers==0.32.2
+dill==0.3.9
+diskcache==5.6.3
+distro==1.9.0
+dnspython==2.7.0
+einops==0.8.1
+email_validator==2.2.0
+fastapi==0.115.12
+fastapi-cli==0.0.7
+fastrlock==0.8.3
+filelock==3.18.0
+flash_attn_3==3.0.0b1
+frozenlist==1.5.0
+fsspec==2025.3.2
+ftfy==6.3.1
+gguf==0.10.0
+h11==0.14.0
+httpcore==1.0.7
+httptools==0.6.4
+httpx==0.28.1
+huggingface-hub==0.30.1
+idna==3.10
+imageio==2.37.0
+imageio-ffmpeg==0.6.0
+importlib_metadata==8.6.1
+inflect==7.3.1
+interegular==0.3.3
+jaraco.collections==5.1.0
+jaraco.context==5.3.0
+jaraco.functools==4.0.1
+jaraco.text==3.12.1
+Jinja2==3.1.6
+jiter==0.9.0
+jsonschema==4.23.0
+jsonschema-specifications==2024.10.1
+lark==1.2.2
+llguidance==0.7.11
+llvmlite==0.43.0
+lm-format-enforcer==0.10.11
+loguru==0.7.3
+markdown-it-py==3.0.0
+MarkupSafe==3.0.2
+mdurl==0.1.2
+mistral_common==1.5.4
+more-itertools==10.3.0
+mpmath==1.3.0
+msgpack==1.1.0
+msgspec==0.19.0
+multidict==6.3.1
+nest-asyncio==1.6.0
+networkx==3.4.2
+ninja==1.11.1.4
+numba==0.60.0
+numpy==1.26.4
+nvidia-cublas-cu12==12.4.5.8
+nvidia-cuda-cupti-cu12==12.4.127
+nvidia-cuda-nvrtc-cu12==12.4.127
+nvidia-cuda-runtime-cu12==12.4.127
+nvidia-cudnn-cu12==9.1.0.70
+nvidia-cufft-cu12==11.2.1.3
+nvidia-curand-cu12==10.3.5.147
+nvidia-cusolver-cu12==11.6.1.9
+nvidia-cusparse-cu12==12.3.1.170
+nvidia-cusparselt-cu12==0.6.2
+nvidia-nccl-cu12==2.21.5
+nvidia-nvjitlink-cu12==12.4.127
+nvidia-nvtx-cu12==12.4.127
+openai==1.70.0
+opencv-python==4.11.0.86
+opencv-python-headless==4.11.0.86
+outlines==0.1.11
+outlines_core==0.1.26
+packaging==24.2
+partial-json-parser==0.2.1.1.post5
+pillow==11.1.0
+platformdirs==4.2.2
+prometheus-fastapi-instrumentator==7.1.0
+prometheus_client==0.21.1
+propcache==0.3.1
+protobuf==6.30.2
+psutil==7.0.0
+py-cpuinfo==9.0.0
+pycountry==24.6.1
+pydantic==2.11.1
+pydantic_core==2.33.0
+Pygments==2.19.1
+python-dotenv==1.1.0
+python-json-logger==3.3.0
+python-multipart==0.0.20
+PyYAML==6.0.2
+pyzmq==26.3.0
+qtorch==0.3.0
+ray==2.44.1
+referencing==0.36.2
+regex==2024.11.6
+requests==2.32.3
+rich==14.0.0
+rich-toolkit==0.14.1
+rpds-py==0.24.0
+safetensors==0.5.3
+scipy==1.15.2
+sentencepiece==0.2.0
+sgl-kernel==0.0.6
+shellingham==1.5.4
+sniffio==1.3.1
+starlette==0.46.1
+sympy==1.13.1
+tiktoken==0.9.0
+tokenizers==0.21.1
+tomli==2.0.1
+torch==2.6.0
+torchaudio==2.6.0
+torchvision==0.21.0
+tqdm==4.67.1
+transformers==4.50.3
+triton==3.2.0
+typeguard==4.3.0
+typer==0.15.2
+typing-inspection==0.4.0
+typing_extensions==4.13.0
+urllib3==2.3.0
+uvicorn==0.34.0
+uvloop==0.21.0
+vllm==0.8.2
+watchfiles==1.0.4
+wcwidth==0.2.13
+websockets==15.0.1
+xformers==0.0.29.post2
+xgrammar==0.1.16
+yarl==1.18.3
+zipp==3.21.0