Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Summary
<!-- 1–3 sentences. What does this PR do and why? -->

## Related
<!-- Closes #123 / Ref tracebloc/other-repo#456 -->

## Type of change
- [ ] Feature
- [ ] Bug fix
- [ ] Tech-debt / refactor
- [ ] Docs
- [ ] Security / hardening
- [ ] Breaking change

## Test plan
<!-- What did you test? Commands run? Manual steps? -->

## Screenshots / recordings
<!-- For UI changes. Remove if N/A. -->

## Deployment notes
<!-- Env vars, migrations, rollout order, feature flags. Remove if N/A. -->

## Checklist
- [ ] Tests added / updated and passing locally
- [ ] Docs updated if behavior or config changed
- [ ] No secrets / credentials in the diff
- [ ] For security-sensitive paths: appropriate reviewer requested
16 changes: 16 additions & 0 deletions .github/workflows/add-to-kanban.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Add to engineer kanban

on:
issues:
types: [opened, reopened, transferred]
pull_request:
types: [opened, reopened, ready_for_review]

jobs:
add-to-project:
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@v1.0.2
with:
project-url: https://github.com/orgs/tracebloc/projects/2
github-token: ${{ secrets.PROJECTS_KANBAN_TOKEN }}
10 changes: 10 additions & 0 deletions .github/workflows/customer-priority-bump.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Customer priority bump

on:
issues:
types: [labeled]

jobs:
bump:
uses: tracebloc/.github/.github/workflows/customer-priority-bump.yml@main
secrets: inherit
12 changes: 12 additions & 0 deletions .github/workflows/kanban-closure-routing.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Kanban closure routing

on:
pull_request:
types: [closed]
issues:
types: [closed]

jobs:
route:
uses: tracebloc/.github/.github/workflows/kanban-closure-router.yml@main
secrets: inherit
10 changes: 10 additions & 0 deletions .github/workflows/set-pr-status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Set PR Status

on:
pull_request:
types: [opened, reopened, ready_for_review, converted_to_draft]

jobs:
set-status:
uses: tracebloc/.github/.github/workflows/set-pr-status.yml@main
secrets: inherit
33 changes: 33 additions & 0 deletions .github/workflows/stale-backlog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Close stale backlog issues

on:
schedule:
- cron: '0 0 * * 1' # Mondays 00:00 UTC
workflow_dispatch: {}

permissions:
issues: write
pull-requests: write

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
days-before-issue-stale: 42 # 6 weeks of no activity → warning
days-before-issue-close: 14 # +2 weeks of silence → close
stale-issue-label: 'stale'
stale-issue-message: |
👋 This issue has had no activity for 6 weeks.

If it's still relevant, please leave a comment with current context (or assign someone). Otherwise it will auto-close in 2 weeks.

To exempt permanently, add the `keep-open` label.
close-issue-message: |
Closing due to 8+ weeks of inactivity. Please reopen with current context if relevant.
exempt-issue-labels: 'keep-open,blocked'
# PRs: don't auto-stale — branch protection + active reviews govern those
days-before-pr-stale: -1
days-before-pr-close: -1
operations-per-run: 50
10 changes: 10 additions & 0 deletions .github/workflows/wip-limit-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: WIP limit check

on:
pull_request:
types: [opened, ready_for_review]
Comment thread
shujaatTracebloc marked this conversation as resolved.

jobs:
check:
uses: tracebloc/.github/.github/workflows/wip-limit-check.yml@main
secrets: inherit
146 changes: 146 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
xrays/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# ds store
.DS_Store/*

.idea
.DS_Store

35 changes: 35 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## What this repo does

Jupyter notebook quick-start guide for running ML training experiments on the tracebloc platform. Walks users through connecting their account, uploading a model, linking a dataset, configuring training parameters, and starting an experiment.

## Notebook locations

- `notebooks/traceblocTrainingGuide.ipynb` -- main training guide (also available on [Google Colab](https://colab.research.google.com/drive/1N00idtpoaq1lk9OJE6g4bMqd8o-Qex2C?usp=sharing))
- `notebooks/GenerateCheckWeights.ipynb` -- utility for generating/checking model weights

## How users run it

### Google Colab (recommended)
Open the Colab link, copy to Drive, and run cells.

### Locally
```bash
pip install "tracebloc[pytorch]>=0.8.1"
jupyter notebook notebooks/traceblocTrainingGuide.ipynb
```

## Prerequisites

- A tracebloc account
- An active use case with a dataset
- A model file (from the [model-zoo](https://github.com/tracebloc/model-zoo) repo or custom)

## Key dependency

[`tracebloc`](https://pypi.org/project/tracebloc/) (PyPI, 0.8.x+) -- the Python SDK used in the notebook to authenticate, upload models, and start training.

> Was published as `tracebloc_package` before 0.8.0. The old install command (`pip install tracebloc_package`) still resolves via a metadata-only redirect on PyPI, but new notebooks should use the canonical `tracebloc` name.
Loading
Loading