Skip to content

Commit 8dbdc38

Browse files
authored
Merge pull request #10 from VectorInstitute/improve_landing_page
Improve landing page
2 parents 03f520d + 3929447 commit 8dbdc38

File tree

12 files changed

+494
-212
lines changed

12 files changed

+494
-212
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Reference Implementation Catalog
1+
# Contributing to Implementation Catalog
22

3-
Thank you for your interest in contributing to the Vector Institute Reference Implementation Catalog!
3+
Thank you for your interest in contributing to the Vector Institute Implementation Catalog!
44

55
## Adding a New Implementation
66

@@ -69,4 +69,4 @@ Then visit http://localhost:8000 in your browser.
6969

7070
## Additional Information
7171

72-
For questions about contributing to the Reference Implementation Catalog, please reach out to the AI Engineering team at Vector Institute.
72+
For questions about contributing to the Implementation Catalog, please reach out to the AI Engineering team at Vector Institute.

README.md

Lines changed: 28 additions & 26 deletions
Large diffs are not rendered by default.
-58.8 KB
Binary file not shown.

docs/assets/splash.png

2.56 MB
Loading

docs/implementation_details.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,28 @@ Each repository in this catalog contains implementations of specific machine lea
66
- **Description**: Brief introduction to the repository's purpose and links to relevant research papers
77
- **Algorithms**: List of ML algorithms demonstrated in the repository
88
- **Datasets**: Information on datasets used, with links to publicly available data
9+
- **Type**: The category of implementation:
10+
* **bootcamp**: Educational implementations developed for workshops and learning purposes
11+
* **tool**: Utility libraries and tools for broader use
12+
* **applied-research**: Research code tied to specific projects or papers
13+
- **Year**: The year the implementation was published
914

1015
## Usage Notes
1116

1217
!!! note
1318
- Many repositories contain code for reference purposes only. To run them, updates may be required to the code and environment files.
1419
- Links for only publicly available datasets are provided. Many datasets used in the repositories are only available on the Vector cluster.
1520

21+
## Repository Organization
22+
23+
The catalog is organized by implementation type to help you quickly find the resources you need:
24+
25+
* **Bootcamp implementations**: Educational resources designed for workshops and learning purposes
26+
* **Tool implementations**: Utility libraries and general-purpose tools
27+
* **Applied Research implementations**: Code tied to specific research projects or papers
28+
29+
Each implementation includes algorithm tags, dataset information, and other metadata to aid in discovery.
30+
1631
## Contributing
1732

1833
If you are a Vector researcher or engineer and would like to add your implementation to this catalog, you can contribute by following our [contribution guidelines](https://github.com/VectorInstitute/reference-implementation-catalog/blob/main/CONTRIBUTING.md).
@@ -23,3 +38,5 @@ To submit issues or suggestions, please use our provided templates:
2338
* [Request a feature](https://github.com/VectorInstitute/reference-implementation-catalog/issues/new?template=feature_request.md) - for suggesting improvements or new additions
2439

2540
For any questions, please reach out to the AI Engineering team at Vector Institute.
41+
42+
<div style="margin-bottom: 4rem;"></div>

0 commit comments

Comments
 (0)