Skip to content

Commit f0e9a85

Browse files
committed
ss
1 parent 7187797 commit f0e9a85

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

defaultplusplus/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ HuggingFace transformers.
99
This document covers the **installable Python package**: API surface,
1010
examples, and the build / publish workflow. For the research-side
1111
reproduction, training, and benchmark-construction flow see
12-
[`RESEARCH.md`](RESEARCH.md). The frozen output schema is in
13-
[`../docs/SPEC.md`](../docs/SPEC.md).
12+
[`RESEARCH.md`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/RESEARCH.md). The frozen output schema is in
13+
[`docs/SPEC.md`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/docs/SPEC.md).
1414

1515
## Install
1616

@@ -140,12 +140,12 @@ literature:
140140
| `wikitext2` | decoder | eval_loss ||
141141

142142
Adding a new task means registering one `TaskMetricSpec` in
143-
[`benchmark/task_metrics.py`](src/defaultplusplus/benchmark/task_metrics.py);
143+
[`benchmark/task_metrics.py`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/src/defaultplusplus/benchmark/task_metrics.py);
144144
nothing else in the runner / CLI changes.
145145

146146
### Output keys
147147

148-
All output keys are frozen by [`../docs/SPEC.md`](../docs/SPEC.md).
148+
All output keys are frozen by [`docs/SPEC.md`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/docs/SPEC.md).
149149
The vector is a flat `dict[str, float]` covering:
150150

151151
- training dynamics: `train_loss`, `train_learning_rate`, `runtime_step_time`, ...
@@ -159,8 +159,8 @@ The vector is a flat `dict[str, float]` covering:
159159

160160
| File | Path | What it shows |
161161
|---|---|---|
162-
| Manual loop | [`examples/extract_during_finetune.py`](examples/extract_during_finetune.py) | DistilBERT + synthetic SST-2 |
163-
| HF Trainer | [`examples/extract_with_hf_trainer.py`](examples/extract_with_hf_trainer.py) | `compute_loss` override + callback |
162+
| Manual loop | [`examples/extract_during_finetune.py`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/examples/extract_during_finetune.py) | DistilBERT + synthetic SST-2 |
163+
| HF Trainer | [`examples/extract_with_hf_trainer.py`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/examples/extract_with_hf_trainer.py) | `compute_loss` override + callback |
164164

165165
Run them after installing the `[hf]` extra:
166166

@@ -260,9 +260,9 @@ and uploading uses `build` + `twine`.
260260

261261
### Bump the version
262262

263-
Update [`src/defaultplusplus/_version.py`](src/defaultplusplus/_version.py)
263+
Update [`src/defaultplusplus/_version.py`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/src/defaultplusplus/_version.py)
264264
following Semantic Versioning (`MAJOR.MINOR.PATCH`). Add an entry at
265-
the top of [`CHANGELOG.md`](CHANGELOG.md). The version field in
265+
the top of [`CHANGELOG.md`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/CHANGELOG.md). The version field in
266266
`pyproject.toml` is dynamic and reads from `_version.py` so the two
267267
cannot drift apart.
268268

@@ -328,9 +328,9 @@ Semantic Versioning 2.0:
328328
- **PATCH** for backwards-compatible bug fixes.
329329

330330
The current version is read from
331-
[`src/defaultplusplus/_version.py`](src/defaultplusplus/_version.py)
331+
[`src/defaultplusplus/_version.py`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/src/defaultplusplus/_version.py)
332332
and surfaced as `defaultplusplus.__version__`.
333333

334334
## License
335335

336-
Apache-2.0. See [`LICENSE`](LICENSE).
336+
Apache-2.0. See [`LICENSE`](https://github.com/SigmaJahan/DEFaultplusplus-Transformer-Debugging/blob/main/defaultplusplus/LICENSE).

0 commit comments

Comments
 (0)