Skip to content

Commit 1f34b8d

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 1f34b8d

127 files changed

Lines changed: 11441 additions & 1064 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: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
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: cmd
71+
run: |
72+
mkdir data 2>nul
73+
start /B python -m tracking_server.cli ui --port 8000
74+
timeout /t 2 /nobreak >nul
75+
curl -s http://127.0.0.1:8000/health >nul 2>&1 || timeout /t 3 /nobreak >nul
76+
curl -s http://127.0.0.1:8000/health >nul 2>&1 || timeout /t 5 /nobreak >nul
77+
curl -s http://127.0.0.1:8000/health >nul 2>&1 || (echo Server failed to start && exit /b 1)
78+
echo Server is ready
79+
80+
- name: Run pytest
81+
run: pytest tests/ -v --tb=short
82+
env:
83+
TRACKING_SERVER_HOST: ${{ runner.os == 'Windows' && '127.0.0.1' || 'localhost' }}
84+
85+
- name: Stop Artifacta server (Unix)
86+
if: always() && runner.os != 'Windows'
87+
run: |
88+
if [ -f server.pid ]; then
89+
kill $(cat server.pid) || true
90+
rm server.pid
91+
fi
92+
93+
- name: Stop Artifacta server (Windows)
94+
if: always() && runner.os == 'Windows'
95+
shell: cmd
96+
run: |
97+
taskkill /F /IM python.exe /FI "WINDOWTITLE eq *tracking_server*" 2>nul || echo No server process found
98+
99+
e2e:
100+
name: E2E Tests on ${{ matrix.os }}
101+
runs-on: ${{ matrix.os }}
102+
strategy:
103+
fail-fast: false
104+
matrix:
105+
os: [ubuntu-latest, macos-latest, windows-latest]
106+
107+
steps:
108+
- uses: actions/checkout@v4
109+
110+
- name: Set up Python 3.11
111+
uses: actions/setup-python@v5
112+
with:
113+
python-version: '3.11'
114+
115+
- name: Set up Node.js
116+
uses: actions/setup-node@v4
117+
with:
118+
node-version: '20'
119+
120+
- name: Install Python dependencies
121+
run: |
122+
python -m pip install --upgrade pip
123+
pip install -e '.[dev]'
124+
125+
- name: Install Node dependencies and build UI
126+
run: npm install && npm run build
127+
128+
- name: Install Playwright browsers
129+
run: npx playwright install --with-deps chromium
130+
131+
- name: Run E2E tests
132+
run: npm run test:e2e
133+
env:
134+
ARTIFACTA_URL: ${{ runner.os == 'Windows' && 'http://127.0.0.1:8000' || 'http://localhost:8000' }}
135+
136+
lint:
137+
name: Lint
138+
runs-on: ubuntu-latest
139+
140+
steps:
141+
- uses: actions/checkout@v4
142+
143+
- name: Set up Python 3.11
144+
uses: actions/setup-python@v5
145+
with:
146+
python-version: '3.11'
147+
148+
- name: Install dependencies
149+
run: |
150+
python -m pip install --upgrade pip
151+
pip install -e '.[dev]'
152+
153+
- name: Run ruff
154+
run: ruff check . --fix
155+
156+
- name: Run mypy
157+
run: mypy --ignore-missing-imports tracking-server
158+
159+
build:
160+
name: Build Package
161+
runs-on: ubuntu-latest
162+
163+
steps:
164+
- uses: actions/checkout@v4
165+
166+
- name: Set up Python 3.11
167+
uses: actions/setup-python@v5
168+
with:
169+
python-version: '3.11'
170+
171+
- name: Install build tools
172+
run: |
173+
python -m pip install --upgrade pip
174+
pip install build
175+
176+
- name: Build package
177+
run: python -m build
178+
179+
- name: Upload artifacts
180+
uses: actions/upload-artifact@v4
181+
with:
182+
name: dist
183+
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)