Skip to content

Commit 1278cf6

Browse files
amrit110amrit110
authored
Merge pull request #7 from VectorInstitute/add_webpage
Add webpage
2 parents 15a4a96 + 88c2c09 commit 1278cf6

23 files changed

+2512
-6
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
### To Reproduce
14+
Code snippet or clear steps to reproduce behaviour.
15+
16+
### Expected behavior
17+
A clear and concise description of what you expected to happen.
18+
19+
### Screenshots
20+
If applicable, add screenshots to help explain your problem.
21+
22+
### Version
23+
- Version info such as v0.1.5
24+
25+
### Additional context
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Is your feature request related to a problem? Please describe.
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
### Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
### Describe alternatives you've considered
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
### Additional context
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# PR Type
2+
[Feature | Fix | Documentation | Other() ]
3+
4+
# Short Description
5+
...
6+
7+
# Tests Added
8+
...

‎.github/workflows/code_checks.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: code checks
2+
permissions:
3+
contents: read
4+
pull-requests: write
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
paths:
11+
- .pre-commit-config.yaml
12+
- .github/workflows/code_checks.yml
13+
- '**.py'
14+
- uv.lock
15+
- pyproject.toml
16+
- '**.ipynb'
17+
pull_request:
18+
branches:
19+
- main
20+
paths:
21+
- .pre-commit-config.yaml
22+
- .github/workflows/code_checks.yml
23+
- '**.py'
24+
- uv.lock
25+
- pyproject.toml
26+
- '**.ipynb'
27+
28+
jobs:
29+
run-code-check:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/[email protected]
33+
34+
- name: Install uv
35+
uses: astral-sh/setup-uv@0c5e2b8115b80b4c7c5ddf6ffdd634974642d182
36+
with:
37+
# Install a specific version of uv.
38+
version: "0.5.21"
39+
enable-cache: true
40+
41+
- name: "Set up Python"
42+
uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55
43+
with:
44+
python-version-file: ".python-version"
45+
46+
- name: Install the project
47+
run: uv sync --all-extras --dev
48+
49+
- name: Install dependencies and check code
50+
run: |
51+
source .venv/bin/activate
52+
pre-commit run --all-files
53+
54+
- name: pip-audit (gh-action-pip-audit)
55+
uses: pypa/gh-action-pip-audit@1220774d901786e6f652ae159f7b6bc8fea6d266
56+
with:
57+
virtual-environment: .venv/

‎.github/workflows/docs.yml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: docs
2+
permissions:
3+
contents: write
4+
pull-requests: write
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
paths:
11+
- .github/workflows/docs.yml
12+
- '**.md'
13+
- '**.html'
14+
- '**.js'
15+
- '**.css'
16+
- mkdocs.yml
17+
- '**.png'
18+
- '**.svg'
19+
- pyproject.toml
20+
pull_request:
21+
branches:
22+
- main
23+
paths:
24+
- .github/workflows/docs.yml
25+
- '**.md'
26+
- '**.html'
27+
- '**.js'
28+
- '**.css'
29+
- mkdocs.yml
30+
- '**.png'
31+
- '**.svg'
32+
- pyproject.toml
33+
34+
jobs:
35+
build:
36+
runs-on: ubuntu-latest
37+
steps:
38+
- name: Checkout code
39+
uses: actions/[email protected]
40+
41+
- name: Install uv
42+
uses: astral-sh/setup-uv@v5
43+
with:
44+
version: "0.6.13"
45+
enable-cache: true
46+
47+
- name: Set up Python
48+
uses: actions/setup-python@v5
49+
with:
50+
python-version: '3.10'
51+
52+
- name: Install dependencies
53+
run: uv sync --dev --group docs
54+
55+
- name: Build docs
56+
run: uv run mkdocs build --clean
57+
58+
- name: Create .nojekyll file
59+
run: touch site/.nojekyll
60+
61+
- name: Upload artifact
62+
uses: actions/upload-artifact@v4
63+
with:
64+
name: docs-site
65+
path: site/
66+
retention-days: 1
67+
68+
deploy:
69+
needs: build
70+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
71+
runs-on: ubuntu-latest
72+
steps:
73+
- name: Checkout code
74+
uses: actions/[email protected]
75+
76+
- name: Configure Git Credentials
77+
run: |
78+
git config user.name github-actions[bot]
79+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
80+
81+
- name: Download artifact
82+
uses: actions/download-artifact@v4
83+
with:
84+
name: docs-site
85+
path: site
86+
87+
- name: Ensure .nojekyll exists
88+
run: touch site/.nojekyll
89+
90+
- name: Deploy to Github pages
91+
uses: JamesIves/[email protected]
92+
with:
93+
branch: gh-pages
94+
folder: site

‎.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Python-generated files
2+
__pycache__/
3+
*.py[oc]
4+
build/
5+
dist/
6+
wheels/
7+
*.egg-info
8+
9+
# Virtual environments
10+
.venv
11+
12+
# Lint & Test
13+
.mypy_cache/
14+
.pytest_cache/
15+
.ruff_cache/
16+
17+
# Vscode
18+
.vscode
19+
20+
# macos
21+
*.DS_Store

‎.pre-commit-config.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v5.0.0 # Use the ref you want to point at
4+
hooks:
5+
- id: trailing-whitespace
6+
- id: check-ast
7+
- id: check-builtin-literals
8+
- id: check-docstring-first
9+
- id: check-executables-have-shebangs
10+
- id: debug-statements
11+
- id: end-of-file-fixer
12+
- id: mixed-line-ending
13+
args: [--fix=lf]
14+
- id: check-byte-order-marker
15+
- id: check-merge-conflict
16+
- id: check-symlinks
17+
- id: detect-private-key
18+
- id: check-yaml
19+
args: [--unsafe]
20+
- id: check-toml
21+
22+
- repo: https://github.com/astral-sh/uv-pre-commit
23+
rev: 0.6.13
24+
hooks:
25+
- id: uv-lock
26+
27+
- repo: https://github.com/astral-sh/ruff-pre-commit
28+
rev: 'v0.11.4'
29+
hooks:
30+
- id: ruff
31+
args: [--fix, --exit-non-zero-on-fix]
32+
types_or: [python, jupyter]
33+
- id: ruff-format
34+
types_or: [python, jupyter]
35+
36+
- repo: https://github.com/crate-ci/typos
37+
rev: v1 # v1.19.0
38+
hooks:
39+
- id: typos
40+
args: []
41+
42+
ci:
43+
autofix_commit_msg: |
44+
[pre-commit.ci] Add auto fixes from pre-commit.com hooks
45+
46+
for more information, see https://pre-commit.ci
47+
autofix_prs: true
48+
autoupdate_branch: ''
49+
autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
50+
autoupdate_schedule: weekly
51+
submodules: false

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.12

‎.typos.toml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[default]
2+
extend-ignore-re = [
3+
"EHR",
4+
"Ehr",
5+
"Yau",
6+
"Tak",
7+
"DOTA"
8+
]
9+
10+
[default.extend-words]
11+
Tak = "Tak"
12+
Yau = "Yau"
13+
EHR = "EHR"
14+
Ehr = "Ehr"
15+
DOTA = "DOTA"

‎CONTRIBUTING.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Reference Implementation Catalog
2+
3+
Thank you for your interest in contributing to the Vector Institute Reference Implementation Catalog!
4+
5+
## Adding a New Implementation
6+
7+
If you are a Vector researcher or engineer and would like to add your implementation to this catalog, please follow these steps:
8+
9+
1. Create a new entry in the appropriate year section of the `docs/index.md` file, following the existing format.
10+
2. Make sure to include:
11+
- Repository link
12+
- Short description
13+
- Tags for relevant technologies/algorithms
14+
- Information about datasets used
15+
16+
## Submitting Changes
17+
18+
To submit changes to this catalog:
19+
20+
1. Fork the repository
21+
2. Create a feature branch
22+
3. Make your changes
23+
4. Submit a pull request
24+
25+
When submitting a PR, please fill out the PR template. If the PR fixes an issue, don't forget to link the PR to the issue!
26+
27+
## Issue Templates
28+
29+
We have templates available for:
30+
- Bug reports
31+
- Feature requests
32+
33+
Please use these templates when opening new issues to ensure all necessary information is provided.
34+
35+
## Additional Information
36+
37+
For questions about contributing to the Reference Implementation Catalog, please reach out to the AI Engineering team at Vector Institute.

0 commit comments

Comments
 (0)