JinchuanTian commited on
Commit
222c12c
·
verified ·
1 Parent(s): 91eb1ca

Use a configuration-inclusive revision in the download instructions

Browse files

Publish the existing ESPnet configuration as config.yaml so normal repository downloads include a Hugging Face download-counting query file. Document the configuration filename and preserve release integrity checks.

Files changed (1) hide show
  1. README.md +3 -2
README.md CHANGED
@@ -40,6 +40,7 @@ descriptions spanning speech, music, environmental sound, and mixtures of them.
40
  |---|---|
41
  | `base.pt` | Native ESPnet weight-only checkpoint |
42
  | `train_stage2_qwen3_base.yaml` | Reconstructed checkpoint-compatible model configuration |
 
43
 
44
  `base.pt` is a PyTorch mapping with model state under the top-level `module` key. It
45
  contains 1,382 tensors: 1,381 BF16 tensors from training and one deterministic FP32
@@ -55,7 +56,7 @@ fields should not be treated as an archival record of every training setting.
55
 
56
  ```bash
57
  hf download espnet/bagpiper \
58
- --revision d7b91ab261116973fb65cf44ff9590f6f242323b \
59
  --local-dir bagpiper-base
60
 
61
  echo "c9917c1237bd44ea0ea8b41746e5ec5aecae92273538c9b6e4040d26f69a6521 bagpiper-base/base.pt" \
@@ -80,7 +81,7 @@ sequence interface.
80
  ## ESPnet runtime
81
 
82
  The native consumer is `espnet2/speechlm/bin/inference.py`. Reconstruct the model with
83
- the supplied training YAML, pair it with the task-appropriate inference YAML from the
84
  [Bagpiper recipe](https://github.com/jctian98/espnet/tree/1992821bfb6d68c6636d1b75340b8b2b591bc015/egs2/bagpiper/speechlm1),
85
  and pass `base.pt` through `--model-checkpoint`.
86
 
 
40
  |---|---|
41
  | `base.pt` | Native ESPnet weight-only checkpoint |
42
  | `train_stage2_qwen3_base.yaml` | Reconstructed checkpoint-compatible model configuration |
43
+ | `config.yaml` | Identical copy of `train_stage2_qwen3_base.yaml` under the standard configuration filename |
44
 
45
  `base.pt` is a PyTorch mapping with model state under the top-level `module` key. It
46
  contains 1,382 tensors: 1,381 BF16 tensors from training and one deterministic FP32
 
56
 
57
  ```bash
58
  hf download espnet/bagpiper \
59
+ --revision 91eb1ca645fe912a7f1b07ce6ff418accf3986cd \
60
  --local-dir bagpiper-base
61
 
62
  echo "c9917c1237bd44ea0ea8b41746e5ec5aecae92273538c9b6e4040d26f69a6521 bagpiper-base/base.pt" \
 
81
  ## ESPnet runtime
82
 
83
  The native consumer is `espnet2/speechlm/bin/inference.py`. Reconstruct the model with
84
+ `config.yaml`, pair it with the task-appropriate inference YAML from the
85
  [Bagpiper recipe](https://github.com/jctian98/espnet/tree/1992821bfb6d68c6636d1b75340b8b2b591bc015/egs2/bagpiper/speechlm1),
86
  and pass `base.pt` through `--model-checkpoint`.
87