Skip to content

Commit 6c3678f

Browse files
authored
remove research docs references (#178)
Remove research readmes references. Signed-off-by: shanjiaz <[email protected]>
1 parent 718ff10 commit 6c3678f

File tree

4 files changed

+6
-19
lines changed

4 files changed

+6
-19
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@ print(speculators.__version__)
193193

194194
Here you can find links to our research implementations. These provide prototype code for immediate enablement and experimentation, with plans for productization into the main package soon.
195195

196-
- [eagle3](https://github.com/neuralmagic/speculators/tree/main/research/eagle3): This implementation trains models similar to the EAGLE 3 architecture, specifically utilizing the Train Time Test method.
196+
- eagle3: This implementation trains models similar to the EAGLE 3 architecture, specifically utilizing the Train Time Test method.
197197

198-
- [hass](https://github.com/neuralmagic/speculators/tree/main/research/hass): This implementation trains models that are a variation on the EAGLE 1 architecture using the [HASS](https://github.com/HArmonizedSS/HASS) method.
198+
- hass: This implementation trains models that are a variation on the EAGLE 1 architecture using the [HASS](https://github.com/HArmonizedSS/HASS) method.
199199

200200
## License
201201

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ VLLM_USE_V1=1 vllm serve RedHatAI/Qwen3-8B-speculator.eagle3
101101

102102
Speculators includes prototype implementations of cutting-edge speculative decoding research:
103103

104-
- **[EAGLE 3](https://github.com/neuralmagic/speculators/blob/main/research/eagle3/README.md)**: Train Time Test method implementation for advanced token speculation
105-
- **[HASS](https://github.com/neuralmagic/speculators/blob/main/research/hass/README.md)**: EAGLE 1 architecture variation using the HASS training method
104+
- **EAGLE 3**: Train Time Test method implementation for advanced token speculation
105+
- **HASS**: EAGLE 1 architecture variation using the HASS training method

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Training
22

3-
Speculators currently supports training of Eagle, Eagle 3 and HASS-style speculative decoders. This functionality is still under development and includes the necessary data generation and training steps required to produce the models. Examples of the training process can be found under the [`research`](https://github.com/neuralmagic/speculators/tree/main/research) directory for [Eagle 3](https://github.com/neuralmagic/speculators/blob/main/research/eagle3/README.md) and [HASS](https://github.com/neuralmagic/speculators/blob/main/research/hass/README.md).
3+
Speculators currently supports training of Eagle, Eagle 3 and HASS-style speculative decoders. This functionality is still under development and includes the necessary data generation and training steps required to produce the models. Examples of the training process can be found under the research directory for Eagle 3 and HASS.
44

55
# Conversion
66

pyproject.toml

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ warn_redundant_casts = true
129129
warn_unused_ignores = false
130130
show_error_codes = true
131131
namespace_packages = true
132-
exclude = ["venv", ".tox", "build", "dist", "research"]
132+
exclude = ["venv", ".tox", "build", "dist"]
133133

134134
# Silence "type import errors" as our 3rd-party libs does not have types
135135
# Check: https://mypy.readthedocs.io/en/latest/config_file.html#import-discovery
@@ -235,19 +235,6 @@ select = [
235235
"BLE001", # allow catching Exception for conversion errors
236236
]
237237

238-
"research/**/*.py" = [
239-
"PTH", # ignore using os.* instead of Path errors
240-
"T20", # ignore usage of print statement errors
241-
"PLR", # ignore code complexity errors
242-
"NPY", # ignore numpy formatting/usage errors
243-
"E722", # allow bare exception catching
244-
"C90", # ignore code complexity errors
245-
"PGH004", # allow general style ignores
246-
"ERA001", # allow commented-out code
247-
"N80", # allow upper case names
248-
"PLC0415", # ignore import not at top of file errors
249-
]
250-
251238
[tool.ruff.lint.isort]
252239
known-first-party = ["speculators", "tests"]
253240

0 commit comments

Comments
 (0)