You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/implementation_details.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,17 @@ Each repository in this catalog contains implementations of specific machine lea
7
7
-**Algorithms**: List of ML algorithms demonstrated in the repository
8
8
-**Datasets**: Information on datasets used, with links to publicly available data
9
9
-**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
13
13
-**Year**: The year the implementation was published
14
14
15
15
## Usage Notes
16
16
17
17
!!! 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.
20
21
21
22
## Repository Categories
22
23
@@ -27,13 +28,15 @@ The catalog is organized by implementation type to help you quickly find the res
27
28
**Purpose**: Production-ready, reusable libraries and frameworks for practical use
28
29
29
30
**Key Characteristics**:
31
+
30
32
- Comprehensive documentation and APIs
31
33
- Multiple implementation options (CLI, Python API, web interfaces)
32
34
- Focus on usability and deployment
33
35
- Broad applicability across use cases
34
36
- Ready for integration into production systems
35
37
36
38
**Examples**:
39
+
37
40
-**fl4health**: Modular federated learning library with 15+ implemented algorithms
38
41
-**cyclops**: Healthcare ML toolkit with data processing and model deployment capabilities
39
42
-**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
46
49
**Purpose**: Educational implementations developed for workshops and learning purposes
47
50
48
51
**Key Characteristics**:
52
+
49
53
- Step-by-step learning materials
50
54
- Clear documentation with tutorials
51
55
- Simplified implementations for educational clarity
@@ -57,13 +61,15 @@ The catalog is organized by implementation type to help you quickly find the res
57
61
**Purpose**: Research implementations tied to specific papers or novel methodologies
58
62
59
63
**Key Characteristics**:
64
+
60
65
- Often include `paper_url` and `bibtex` fields
61
66
- Implement specific research contributions
62
67
- Focus on reproducibility and experimentation
63
68
- May include novel datasets or pre-trained models
64
69
- Code directly supports published research
65
70
66
71
**Examples**:
72
+
67
73
-**bias-mitigation-unlearning**: Implements specific EMNLP 2024 paper methods (Negation via Task Vectors, PCGU)
68
74
-**kg-rag**: Framework for Knowledge Graph RAG research with specific implementations
69
75
-**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
81
87
82
88
Please use our provided templates:
83
89
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
0 commit comments