Skip to content

Commit adc6926

Browse files
walkerbdevwalkerbdev
committed
Add comprehensive documentation, E2E tests, and CI/CD workflow
- Add JSDoc enforcement and comprehensive docstrings across Python and JavaScript - Implement Playwright E2E test suite for UI validation - Add GitHub Actions CI workflow for cross-platform testing - Add full autolog support for PyTorch Lightning and TensorFlow/Keras - Reorganize examples into core, ml_frameworks, and domain_specific categories - Consolidate config files and improve documentation structure - Remove unique constraint on run names for better usability - Update README with improved problem statement and ecosystem comparison
1 parent d039dce commit adc6926

128 files changed

Lines changed: 11476 additions & 1079 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.depcheckrc.json‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎.github/workflows/ci.yml‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, docs/* ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
os: [ubuntu-latest, macos-latest, windows-latest]
17+
python-version: ['3.9', '3.10', '3.11', '3.12']
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Set up Python ${{ matrix.python-version }}
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
27+
- name: Set up Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: '20'
31+
32+
- name: Install dependencies
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install -e '.[dev]'
36+
37+
- name: Build UI
38+
run: npm install && npm run build
39+
40+
- name: Start Artifacta server (Unix)
41+
if: runner.os != 'Windows'
42+
run: |
43+
mkdir -p data
44+
nohup artifacta ui --port 8000 > server.log 2>&1 &
45+
echo $! > server.pid
46+
47+
# Wait for server to be ready
48+
echo "Waiting for server to start..."
49+
SERVER_READY=false
50+
for i in {1..30}; do
51+
if curl -s http://localhost:8000/health > /dev/null 2>&1; then
52+
echo "✓ Server is ready"
53+
SERVER_READY=true
54+
break
55+
fi
56+
echo "Waiting for server... ($i/30)"
57+
sleep 1
58+
done
59+
60+
# Fail if server never started
61+
if [ "$SERVER_READY" = "false" ]; then
62+
echo "✗ Server failed to start after 30 seconds"
63+
echo "Server log:"
64+
cat server.log
65+
exit 1
66+
fi
67+
68+
- name: Start Artifacta server (Windows)
69+
if: runner.os == 'Windows'
70+
shell: pwsh
71+
run: |
72+
if (-not (Test-Path data)) { New-Item -ItemType Directory -Path data }
73+
$process = Start-Process python -ArgumentList "-m","tracking_server.cli","ui","--port","8000" -PassThru -WindowStyle Hidden
74+
Start-Sleep -Seconds 2
75+
76+
# Health check with retries
77+
$maxAttempts = 5
78+
$attempt = 0
79+
$success = $false
80+
while ($attempt -lt $maxAttempts -and -not $success) {
81+
try {
82+
$response = Invoke-WebRequest -Uri "http://127.0.0.1:8000/health" -UseBasicParsing -TimeoutSec 2
83+
if ($response.StatusCode -eq 200) {
84+
$success = $true
85+
Write-Host "Server is ready"
86+
}
87+
} catch {
88+
$attempt++
89+
if ($attempt -lt $maxAttempts) {
90+
Start-Sleep -Seconds 3
91+
}
92+
}
93+
}
94+
95+
if (-not $success) {
96+
Write-Host "Server failed to start after $maxAttempts attempts"
97+
exit 1
98+
}
99+
100+
- name: Run pytest
101+
run: pytest tests/ -v --tb=short
102+
env:
103+
TRACKING_SERVER_HOST: ${{ runner.os == 'Windows' && '127.0.0.1' || 'localhost' }}
104+
105+
- name: Stop Artifacta server (Unix)
106+
if: always() && runner.os != 'Windows'
107+
run: |
108+
if [ -f server.pid ]; then
109+
kill $(cat server.pid) || true
110+
rm server.pid
111+
fi
112+
113+
- name: Stop Artifacta server (Windows)
114+
if: always() && runner.os == 'Windows'
115+
shell: cmd
116+
run: |
117+
taskkill /F /IM python.exe /FI "WINDOWTITLE eq *tracking_server*" 2>nul || echo No server process found
118+
119+
e2e:
120+
name: E2E Tests on ${{ matrix.os }}
121+
runs-on: ${{ matrix.os }}
122+
strategy:
123+
fail-fast: false
124+
matrix:
125+
os: [ubuntu-latest, macos-latest, windows-latest]
126+
127+
steps:
128+
- uses: actions/checkout@v4
129+
130+
- name: Set up Python 3.11
131+
uses: actions/setup-python@v5
132+
with:
133+
python-version: '3.11'
134+
135+
- name: Set up Node.js
136+
uses: actions/setup-node@v4
137+
with:
138+
node-version: '20'
139+
140+
- name: Install Python dependencies
141+
run: |
142+
python -m pip install --upgrade pip
143+
pip install -e '.[dev]'
144+
145+
- name: Install Node dependencies and build UI
146+
run: npm install && npm run build
147+
148+
- name: Install Playwright browsers
149+
run: npx playwright install --with-deps chromium
150+
151+
- name: Run E2E tests
152+
run: npm run test:e2e
153+
env:
154+
ARTIFACTA_URL: ${{ runner.os == 'Windows' && 'http://127.0.0.1:8000' || 'http://localhost:8000' }}
155+
156+
lint:
157+
name: Lint
158+
runs-on: ubuntu-latest
159+
160+
steps:
161+
- uses: actions/checkout@v4
162+
163+
- name: Set up Python 3.11
164+
uses: actions/setup-python@v5
165+
with:
166+
python-version: '3.11'
167+
168+
- name: Install dependencies
169+
run: |
170+
python -m pip install --upgrade pip
171+
pip install -e '.[dev]'
172+
173+
- name: Run ruff
174+
run: ruff check . --fix
175+
176+
- name: Run mypy
177+
run: mypy --ignore-missing-imports tracking-server
178+
179+
build:
180+
name: Build Package
181+
runs-on: ubuntu-latest
182+
183+
steps:
184+
- uses: actions/checkout@v4
185+
186+
- name: Set up Python 3.11
187+
uses: actions/setup-python@v5
188+
with:
189+
python-version: '3.11'
190+
191+
- name: Install build tools
192+
run: |
193+
python -m pip install --upgrade pip
194+
pip install build
195+
196+
- name: Build package
197+
run: python -m build
198+
199+
- name: Upload artifacts
200+
uses: actions/upload-artifact@v4
201+
with:
202+
name: dist
203+
path: dist/

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,8 @@ logs/
6363
docs/_build/
6464
docs/_static/
6565
docs/_templates/
66+
67+
# Playwright test outputs
68+
test-results/
69+
playwright-report/
70+
playwright/.cache/

‎.pre-commit-config.yaml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,19 @@ repos:
2929
- --convention=google
3030
files: ^(artifacta|tracking-server)/
3131

32-
# ESLint - JavaScript/React linter
32+
# ESLint - JavaScript/React linter with JSDoc enforcement
3333
- repo: https://github.com/pre-commit/mirrors-eslint
3434
rev: v9.17.0
3535
hooks:
3636
- id: eslint
3737
files: \.[jt]sx?$
3838
types: [file]
39+
args: [--config, config/eslint.config.js]
3940
additional_dependencies:
4041
- eslint@9.17.0
4142
- eslint-plugin-react@7.37.2
43+
- eslint-plugin-react-hooks@5.1.0
44+
- eslint-plugin-jsdoc@50.6.1
4245

4346
# Knip - Find unused files, exports, and dependencies (JavaScript/TypeScript)
4447
- repo: local
@@ -51,7 +54,7 @@ repos:
5154
files: \.[jt]sx?$
5255
- id: depcheck
5356
name: depcheck - unused npm dependencies
54-
entry: npx depcheck --ignore-dirs=dist,node_modules,.git
57+
entry: npx depcheck
5558
language: system
5659
pass_filenames: false
5760
files: package\.json

‎CODE_OF_CONDUCT.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Our Pledge
55

6-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
77

88
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
99

@@ -82,4 +82,3 @@ For answers to common questions about this code of conduct, see the FAQ at [http
8282
[Mozilla CoC]: https://github.com/mozilla/diversity
8383
[FAQ]: https://www.contributor-covenant.org/faq
8484
[translations]: https://www.contributor-covenant.org/translations
85-

‎CONTRIBUTING.md‎

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

3-
Thank you for your interest in contributing to Artifacta! 🎉
3+
Thank you for your interest in contributing to Artifacta!
44

55
## How to Contribute
66

0 commit comments

Comments
 (0)