Skip to content

Commit b782ec2

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 b782ec2

118 files changed

Lines changed: 11266 additions & 971 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: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
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+
New-Item -ItemType Directory -Force -Path data
73+
$process = Start-Process -NoNewWindow -FilePath "artifacta" -ArgumentList "ui","--port","8000" -RedirectStandardOutput server.log -RedirectStandardError server-error.log -PassThru
74+
$process.Id | Out-File -FilePath server.pid
75+
76+
# Wait for server to be ready
77+
Write-Host "Waiting for server to start..."
78+
$serverReady = $false
79+
for ($i = 1; $i -le 30; $i++) {
80+
# Check if process is still running
81+
if ($process.HasExited) {
82+
Write-Host "✗ Server process exited prematurely"
83+
Write-Host "Exit code: $($process.ExitCode)"
84+
Write-Host "Server error log:"
85+
Get-Content server-error.log -ErrorAction SilentlyContinue
86+
exit 1
87+
}
88+
89+
try {
90+
$response = Invoke-WebRequest -Uri http://127.0.0.1:8000/health -UseBasicParsing -TimeoutSec 1 -ErrorAction Stop
91+
if ($response.StatusCode -eq 200) {
92+
Write-Host "✓ Server is ready (PID: $($process.Id))"
93+
$serverReady = $true
94+
break
95+
}
96+
} catch {
97+
Write-Host "Waiting for server... ($i/30)"
98+
Start-Sleep -Seconds 1
99+
}
100+
}
101+
102+
# Fail if server never started
103+
if (-not $serverReady) {
104+
Write-Host "✗ Server failed to start after 30 seconds"
105+
Write-Host "Server log:"
106+
Get-Content server.log -ErrorAction SilentlyContinue
107+
Write-Host "Server error log:"
108+
Get-Content server-error.log -ErrorAction SilentlyContinue
109+
exit 1
110+
}
111+
112+
- name: Run pytest
113+
run: pytest tests/ -v --tb=short
114+
env:
115+
TRACKING_SERVER_HOST: ${{ runner.os == 'Windows' && '127.0.0.1' || 'localhost' }}
116+
117+
- name: Stop Artifacta server (Unix)
118+
if: always() && runner.os != 'Windows'
119+
run: |
120+
if [ -f server.pid ]; then
121+
kill $(cat server.pid) || true
122+
rm server.pid
123+
fi
124+
125+
- name: Stop Artifacta server (Windows)
126+
if: always() && runner.os == 'Windows'
127+
shell: pwsh
128+
run: |
129+
Get-Process | Where-Object {$_.ProcessName -eq "artifacta"} | Stop-Process -Force
130+
131+
e2e:
132+
name: E2E Tests on ${{ matrix.os }}
133+
runs-on: ${{ matrix.os }}
134+
strategy:
135+
fail-fast: false
136+
matrix:
137+
os: [ubuntu-latest, macos-latest, windows-latest]
138+
139+
steps:
140+
- uses: actions/checkout@v4
141+
142+
- name: Set up Python 3.11
143+
uses: actions/setup-python@v5
144+
with:
145+
python-version: '3.11'
146+
147+
- name: Set up Node.js
148+
uses: actions/setup-node@v4
149+
with:
150+
node-version: '20'
151+
152+
- name: Install Python dependencies
153+
run: |
154+
python -m pip install --upgrade pip
155+
pip install -e '.[dev]'
156+
157+
- name: Install Node dependencies and build UI
158+
run: npm install && npm run build
159+
160+
- name: Install Playwright browsers
161+
run: npx playwright install --with-deps chromium
162+
163+
- name: Run E2E tests
164+
run: npm run test:e2e
165+
env:
166+
ARTIFACTA_URL: ${{ runner.os == 'Windows' && 'http://127.0.0.1:8000' || 'http://localhost:8000' }}
167+
168+
lint:
169+
name: Lint
170+
runs-on: ubuntu-latest
171+
172+
steps:
173+
- uses: actions/checkout@v4
174+
175+
- name: Set up Python 3.11
176+
uses: actions/setup-python@v5
177+
with:
178+
python-version: '3.11'
179+
180+
- name: Install dependencies
181+
run: |
182+
python -m pip install --upgrade pip
183+
pip install -e '.[dev]'
184+
185+
- name: Run ruff
186+
run: ruff check . --fix
187+
188+
- name: Run mypy
189+
run: mypy --ignore-missing-imports tracking-server
190+
191+
build:
192+
name: Build Package
193+
runs-on: ubuntu-latest
194+
195+
steps:
196+
- uses: actions/checkout@v4
197+
198+
- name: Set up Python 3.11
199+
uses: actions/setup-python@v5
200+
with:
201+
python-version: '3.11'
202+
203+
- name: Install build tools
204+
run: |
205+
python -m pip install --upgrade pip
206+
pip install build
207+
208+
- name: Build package
209+
run: python -m build
210+
211+
- name: Upload artifacts
212+
uses: actions/upload-artifact@v4
213+
with:
214+
name: dist
215+
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-

0 commit comments

Comments
 (0)