Skip to content
Merged
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
3 changes: 1 addition & 2 deletions join-use-case/start-training.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Start Training"
description: "Step-by-step guide to training a model on the tracebloc platform."

Check warning on line 3 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L3

Did you really mean 'tracebloc'?
---

You have joined a use case and accepted the terms. Training a model is easy: you run a Jupyter notebook locally to connect and submit models to the workspace.
Expand All @@ -10,7 +10,7 @@

## Pull Training Notebook and Model Repositories

On your machine, create a tracebloc folder and pull the [Training GitHub repository](https://github.com/tracebloc/start-training/tree/main) and the [Model Zoo GitHub repository](https://github.com/tracebloc/model-zoo/tree/master). The notebook contains all commands to connect and start training, the model zoo contains a selection of compatible models ready for training. The easiest way to customize models is by starting from the model zoo. Open a terminal and run the following commands:

Check warning on line 13 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L13

Did you really mean 'tracebloc'?

```bash
mkdir tracebloc && cd tracebloc
Expand All @@ -25,7 +25,7 @@

## Create a Virtual Environment

Create a new environment, name it for example "tracebloc":

Check warning on line 28 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L28

Did you really mean 'tracebloc'?

```bash
conda create -n tracebloc python=3.12
Expand All @@ -43,9 +43,8 @@

# Install with the extra that matches your framework:
pip install "tracebloc[pytorch]>=0.18.1"
# pip install "tracebloc[tensorflow]>=0.18.1"
# pip install "tracebloc[sklearn]>=0.18.1"
# pip install "tracebloc[all]>=0.18.1" # all frameworks
# pip install "tracebloc[all]>=0.18.1" # pytorch + sklearn + lifelines + scikit-survival
```

## Install and Launch Jupyter Notebook
Expand All @@ -62,9 +61,9 @@
jupyter notebook notebooks/traceblocTrainingGuide.ipynb
```

## 1. Connect to the tracebloc workspace

Check warning on line 64 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L64

Did you really mean 'tracebloc'?

Follow the instructions in the notebook to authenticate. Have your tracebloc user credentials ready:

Check warning on line 66 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L66

Did you really mean 'tracebloc'?

![Log in](/images/Connect-to-the-tracebloc-Client.avif)

Expand All @@ -88,7 +87,7 @@
| Image | Classification | `image_size` has to match image x/y-dimensions <br></br> `output_classes` has to match # of image classes |
| Image | Object Detection | `image_size` has to match image x/y-dimensions <br></br> `output_classes` has to match # of object types |
| Image | Semantic Segmentation | `image_size` has to match image x/y-dimensions <br></br> `output_classes` has to match # of object classes |
| Image | Keypoint Detection | `image_size` has to match image x/y-dimensions <br></br> `output_classes` has to match # of object classes <br></br> `num_feature_points` has to match # of keypoints |

Check warning on line 90 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L90

Did you really mean 'Keypoint'?

Check warning on line 90 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L90

Did you really mean 'keypoints'?
| Tabular | Tabular Classification | `output_classes` has to match # of classes <br></br> `num_feature_points` has to match # of features |
| Text | Text Classification | `input_shape`<br></br> `sequence_length` <br></br> `output_classes` |

Expand Down Expand Up @@ -175,7 +174,7 @@

## 4. Set Training Plan

Set the experiment name and configure hyperparameters.

Check warning on line 177 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L177

Did you really mean 'hyperparameters'?

```python
# Set experiment name
Expand All @@ -189,9 +188,9 @@
training_plan.get_training_plan()
```

Get the training plan to check settings before you start the training. For a detailed list of all hyperparameter options, see [Hyperparameters](/join-use-case/hyperparameters).

Check warning on line 191 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L191

Did you really mean 'hyperparameter'?

For classical, non federated and non gradient descent-based machine learning algorithms like random forests, XGBoost, SVMs, logistic regression, use simplified settings:

Check warning on line 193 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L193

Did you really mean 'XGBoost'?

Check warning on line 193 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L193

Did you really mean 'SVMs'?

```python
# Set training parameters
Expand Down Expand Up @@ -226,9 +225,9 @@

**Note:** The compute budget is set by the use case owner. Your team shares one compute budget with no per-person limit.

## Submit an Experiment to the Leaderboard

Check warning on line 228 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L228

Did you really mean 'Leaderboard'?

Once training is complete, submit your best model to the leaderboard for evaluation on the test dataset. For the full submission flow and leaderboard details, see the [Evaluate Model guide](/join-use-case/model-evaluation#submit-to-leaderboard).

Check warning on line 230 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L230

Did you really mean 'leaderboard'?

Check warning on line 230 in join-use-case/start-training.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

join-use-case/start-training.mdx#L230

Did you really mean 'leaderboard'?

## Inviting Others to Your Team

Expand Down
15 changes: 13 additions & 2 deletions tools-help/tracebloc.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "tracebloc Python SDK"

Check warning on line 2 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L2

Did you really mean 'tracebloc'?
description: "Python library for uploading models, linking them with datasets, configuring training parameters, and launching training runs on the tracebloc platform."

Check warning on line 3 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L3

Did you really mean 'tracebloc'?
---

`tracebloc` is a Python library for uploading models, linking them with datasets, configuring training parameters, and launching training runs on the tracebloc platform.

Check warning on line 6 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L6

Did you really mean 'tracebloc'?

<Note>
The package was renamed from `tracebloc_package` to `tracebloc` in 0.8.0. The old name keeps working — `pip install tracebloc_package` resolves via a redirect, and `from tracebloc_package import User` still works with a `DeprecationWarning`. New code should use the canonical `tracebloc` name; the shim is removed in 1.0.0.

Check warning on line 9 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L9

Did you really mean 'tracebloc_package'?
</Note>

## Installation
Expand All @@ -17,20 +17,31 @@

```bash
pip install "tracebloc[pytorch]>=0.18.1" # most users
# pip install "tracebloc[tensorflow]>=0.18.1" # TensorFlow
# pip install "tracebloc[sklearn]>=0.18.1" # scikit-learn, incl. XGBoost / CatBoost / LightGBM
# pip install "tracebloc[xgboost]>=0.18.1" # one boosting backend only (or: catboost, lightgbm)
# pip install "tracebloc[lifelines,scikit-survival]>=0.18.1" # survival analysis
# pip install "tracebloc[all]>=0.18.1" # everything
# pip install "tracebloc[all]>=0.18.1" # pytorch + sklearn + lifelines + scikit-survival
```

<Note>
**There is no `tensorflow` extra**, and `all` does not include TensorFlow — it
resolves to `pytorch`, `sklearn`, `lifelines` and `scikit-survival`. The
published extras are exactly: `pytorch`, `sklearn`, `xgboost`, `catboost`,
`lightgbm`, `lifelines`, `scikit-survival`, `all` and `dev`.

This matters because of how pip behaves: **an unknown extra is a warning, not an
error, and pip still exits 0**. Asking for one that does not exist therefore
appears to succeed while installing the core SDK only, and the failure surfaces
much later as a missing framework.
</Note>

<Note>
The umbrella `[boosting]` and `[survival]` extras were removed in 0.10.0, along with `[huggingface]` (the Hugging Face stack now ships inside `[pytorch]`). Use the per-library extras above. `pip` does not fail on an unknown extra — it prints a warning, installs the core SDK only, and exits 0, so the mistake surfaces later as an `ImportError`.
</Note>

## Key Features

- Upload model files and pretrained weights

Check warning on line 44 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L44

Did you really mean 'pretrained'?
- Link models with datasets from your use cases
- Configure training parameters (epochs, optimizer, learning rate, augmentation, callbacks)
- Review training plans before starting
Expand Down Expand Up @@ -73,15 +84,15 @@

## Model Zoo

Use a ready-made model from the [tracebloc model zoo](https://github.com/tracebloc/model-zoo) or bring your own. Supported tasks include image classification, object detection, text classification, tabular classification/regression, time series forecasting, semantic segmentation, keypoint detection, and time-to-event prediction.

Check warning on line 87 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L87

Did you really mean 'keypoint'?

## Google Colab Quickstart

Check warning on line 89 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L89

Did you really mean 'Colab'?

The fastest way to get started is our [Google Colab notebook](https://colab.research.google.com/drive/1N00idtpoaq1lk9OJE6g4bMqd8o-Qex2C) — runs entirely in your browser, no local setup needed.

## Next Steps

- [Start training](/join-use-case/start-training) — detailed walkthrough of the training workflow

Check warning on line 95 in tools-help/tracebloc.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc.mdx#L95

Did you really mean 'walkthrough'?
- [Hyperparameters](/join-use-case/hyperparameters) — full reference for all training configuration options
- [FAQs](/tools-help/faqs)
- [Key terms](/tools-help/key-terms)
Expand Down
Loading