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
8 changes: 7 additions & 1 deletion 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.9
Expand All @@ -36,9 +36,15 @@

```bash
python -m pip install --upgrade pip
pip install tracebloc_package

# Pick the extra that matches your ML framework:
pip install "tracebloc_package[pytorch]>=0.6.33" # most common
# pip install "tracebloc_package[tensorflow]>=0.6.33" # TensorFlow
# pip install "tracebloc_package[all]>=0.6.33" # everything
```

See the [tracebloc Package page](/tools-help/tracebloc-package) for all available extras.

## Install and Launch Jupyter Notebook

Install Jupyter into your environments:
Expand All @@ -53,9 +59,9 @@
jupyter notebook notebooks/traceblocTrainingGuide.ipynb
```

## 1. Connect to the tracebloc workspace

Check warning on line 62 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#L62

Did you really mean 'tracebloc'?

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

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'?

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

Expand All @@ -79,7 +85,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 88 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#L88

Did you really mean 'Keypoint'?

Check warning on line 88 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#L88

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 @@ -166,7 +172,7 @@

## 4. Set Training Plan

Set the experiment name and configure hyperparameters.

Check warning on line 175 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#L175

Did you really mean 'hyperparameters'?

```python
# Set experiment name
Expand All @@ -180,9 +186,9 @@
trainingObject.getTrainingPlan()
```

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 189 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#L189

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 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 'XGBoost'?

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 'SVMs'?

```python
# Set training parameters
Expand Down Expand Up @@ -217,9 +223,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 226 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#L226

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 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'?

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'?

## Inviting Others to Your Team

Expand Down
16 changes: 13 additions & 3 deletions tools-help/tracebloc-package.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
---
title: "tracebloc Package"

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

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.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-package.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L3

Did you really mean 'tracebloc'?
---

# tracebloc Package

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

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L6

Did you really mean 'tracebloc'?

The `tracebloc_package` 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 8 in tools-help/tracebloc-package.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L8

Did you really mean 'tracebloc'?

## Installation

```bash
pip install tracebloc_package>=0.6.32
```
ML framework dependencies are optional — pick the extra that matches your setup. The default install is ~140 MB (up from ~8 GB in older versions).

| You use | Install command |
|---|---|
| PyTorch (most common) | `pip install "tracebloc_package[pytorch]>=0.6.33"` |
| TensorFlow | `pip install "tracebloc_package[tensorflow]>=0.6.33"` |
| scikit-learn only | `pip install "tracebloc_package[sklearn]>=0.6.33"` |
| Hugging Face LoRA / PEFT (requires PyTorch) | `pip install "tracebloc_package[pytorch,huggingface]>=0.6.33"` |
| XGBoost / CatBoost / LightGBM | `pip install "tracebloc_package[boosting]>=0.6.33"` |

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

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L20

Did you really mean 'XGBoost'?
| Survival analysis | `pip install "tracebloc_package[survival]>=0.6.33"` |
| Everything | `pip install "tracebloc_package[all]>=0.6.33"` |

Upgrading from 0.6.32 or earlier? See the [migration guide](https://github.com/tracebloc/tracebloc-py-package/blob/develop/MIGRATION.md).

## Key Features

- Upload model files and pretrained weights

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

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L28

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 @@ -58,15 +68,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 71 in tools-help/tracebloc-package.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L71

Did you really mean 'keypoint'?

## Google Colab Quickstart

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

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L73

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 79 in tools-help/tracebloc-package.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

tools-help/tracebloc-package.mdx#L79

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)