Skip to content

Commit a89a2ea

Browse files
committed
Fix lists
1 parent 3349204 commit a89a2ea

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

docs/implementation_details.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ Each repository in this catalog contains implementations of specific machine lea
77
- **Algorithms**: List of ML algorithms demonstrated in the repository
88
- **Datasets**: Information on datasets used, with links to publicly available data
99
- **Type**: The category of implementation:
10-
* **bootcamp**: Educational implementations developed for workshops and learning purposes
11-
* **tool**: Production-ready, reusable libraries and frameworks for practical use
12-
* **applied-research**: Research implementations tied to specific papers or novel methodologies
10+
- **bootcamp**: Educational implementations developed for workshops and learning purposes
11+
- **tool**: Production-ready, reusable libraries and frameworks for practical use
12+
- **applied-research**: Research implementations tied to specific papers or novel methodologies
1313
- **Year**: The year the implementation was published
1414

1515
## Usage Notes
1616

1717
!!! note
18-
- Many repositories contain code for reference purposes only. To run them, updates may be required to the code and environment files.
19-
- Links for only publicly available datasets are provided. Many datasets used in the repositories are only available on the Vector cluster.
18+
Many repositories contain code for reference purposes only. To run them, updates may be required to the code and environment files.
19+
20+
Links for only publicly available datasets are provided. Many datasets used in the repositories are only available on the Vector cluster.
2021

2122
## Repository Categories
2223

@@ -27,13 +28,15 @@ The catalog is organized by implementation type to help you quickly find the res
2728
**Purpose**: Production-ready, reusable libraries and frameworks for practical use
2829

2930
**Key Characteristics**:
31+
3032
- Comprehensive documentation and APIs
3133
- Multiple implementation options (CLI, Python API, web interfaces)
3234
- Focus on usability and deployment
3335
- Broad applicability across use cases
3436
- Ready for integration into production systems
3537

3638
**Examples**:
39+
3740
- **fl4health**: Modular federated learning library with 15+ implemented algorithms
3841
- **cyclops**: Healthcare ML toolkit with data processing and model deployment capabilities
3942
- **vector-inference**: LLM inference system with CLI, Python API, and OpenAI-compatible server
@@ -46,6 +49,7 @@ The catalog is organized by implementation type to help you quickly find the res
4649
**Purpose**: Educational implementations developed for workshops and learning purposes
4750

4851
**Key Characteristics**:
52+
4953
- Step-by-step learning materials
5054
- Clear documentation with tutorials
5155
- Simplified implementations for educational clarity
@@ -57,13 +61,15 @@ The catalog is organized by implementation type to help you quickly find the res
5761
**Purpose**: Research implementations tied to specific papers or novel methodologies
5862

5963
**Key Characteristics**:
64+
6065
- Often include `paper_url` and `bibtex` fields
6166
- Implement specific research contributions
6267
- Focus on reproducibility and experimentation
6368
- May include novel datasets or pre-trained models
6469
- Code directly supports published research
6570

6671
**Examples**:
72+
6773
- **bias-mitigation-unlearning**: Implements specific EMNLP 2024 paper methods (Negation via Task Vectors, PCGU)
6874
- **kg-rag**: Framework for Knowledge Graph RAG research with specific implementations
6975
- **atomgen**: Transformer-based atomistic graph models with pre-trained models
@@ -81,8 +87,8 @@ If you are a Vector researcher or engineer and would like to add your implementa
8187

8288
Please use our provided templates:
8389

84-
* 🐛 [Report a bug](https://github.com/VectorInstitute/reference-implementation-catalog/issues/new?template=bug_report.md) - for reporting problems or errors
85-
*[Request a feature](https://github.com/VectorInstitute/reference-implementation-catalog/issues/new?template=feature_request.md) - for suggesting improvements or new additions
90+
- 🐛 [Report a bug](https://github.com/VectorInstitute/reference-implementation-catalog/issues/new?template=bug_report.md) - for reporting problems or errors
91+
-[Request a feature](https://github.com/VectorInstitute/reference-implementation-catalog/issues/new?template=feature_request.md) - for suggesting improvements or new additions
8692

8793
### ❓ Questions
8894

docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,10 @@ hide:
345345

346346

347347

348+
349+
350+
351+
348352

349353

350354

@@ -674,4 +678,3 @@ hide:
674678
</div>
675679

676680
</div>
677-

0 commit comments

Comments
 (0)