mirror of
https://github.com/clearml/clearml-docs
synced 2025-03-10 06:01:29 +00:00
add megengine example docs (#134)
This commit is contained in:
parent
fdc0d407b5
commit
f44ebcaae9
@ -42,8 +42,10 @@ Check out some of ClearML's automatic reporting examples for supported packages:
|
|||||||
TensorFlow flags
|
TensorFlow flags
|
||||||
* [Tensorboard with PyTorch](../guides/frameworks/pytorch/pytorch_tensorboard.md) - logging TensorBoard scalars, debug samples, and text integrated into
|
* [Tensorboard with PyTorch](../guides/frameworks/pytorch/pytorch_tensorboard.md) - logging TensorBoard scalars, debug samples, and text integrated into
|
||||||
code that uses PyTorch
|
code that uses PyTorch
|
||||||
* [TensorBoardX](../guides/frameworks/tensorboardx/tensorboardx.md) - logging TensorBoardX scalars, debug
|
* TensorBoardX
|
||||||
|
* [TensorBoardX with Pytorch](../guides/frameworks/tensorboardx/tensorboardx.md) - logging TensorBoardX scalars, debug
|
||||||
samples, and text in code using PyTorch
|
samples, and text in code using PyTorch
|
||||||
|
* [MegEngine MNIST](../guides/frameworks/megengine/megengine_mnist.md) - logging scalars using TensorBoardX's `SummaryWriter`
|
||||||
* Matplotlib
|
* Matplotlib
|
||||||
* [Matplotlib](../guides/frameworks/matplotlib/matplotlib_example.md) - logging scatter diagrams plotted with Matplotlib
|
* [Matplotlib](../guides/frameworks/matplotlib/matplotlib_example.md) - logging scatter diagrams plotted with Matplotlib
|
||||||
* [Matplotlib with PyTorch](../guides/frameworks/pytorch/pytorch_matplotlib.md) - logging debug images shown
|
* [Matplotlib with PyTorch](../guides/frameworks/pytorch/pytorch_matplotlib.md) - logging debug images shown
|
||||||
|
54
docs/guides/frameworks/megengine/megengine_mnist.md
Normal file
54
docs/guides/frameworks/megengine/megengine_mnist.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
---
|
||||||
|
title: MegEngine MNIST
|
||||||
|
---
|
||||||
|
|
||||||
|
The [megengine_mnist.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/megengine/megengine_mnist.py)
|
||||||
|
example demonstrates the integration of ClearML into code that uses [MegEngine](https://github.com/MegEngine/MegEngine)
|
||||||
|
and [TensorBoardX](https://github.com/lanpa/tensorboardX). ClearML automatically captures models saved with `megengine`.
|
||||||
|
|
||||||
|
The example script does the following:
|
||||||
|
* Trains a simple deep neural network on MegEngine's built-in [MNIST](https://megengine.org.cn/doc/stable/en/reference/api/megengine.data.dataset.MNIST.html)
|
||||||
|
dataset.
|
||||||
|
* Creates a TensorBoardX `SummaryWriter` object to log scalars during training.
|
||||||
|
* Creates a ClearML experiment named `megengine mnist train`, which is associated with the `examples` project.
|
||||||
|
|
||||||
|
## Hyperparameters
|
||||||
|
|
||||||
|
ClearML automatically logs command line options defined with `argparse`. They appear in the experiment's **CONFIGURATIONS**
|
||||||
|
page under **HYPER PARAMETERS** **>** **Args**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Scalars
|
||||||
|
|
||||||
|
The example script's `train` function calls TensorBoardX's `SummaryWriter.add_scalar` method to report `loss`.
|
||||||
|
ClearML automatically captures the data that is added to the `SummaryWriter` object.
|
||||||
|
|
||||||
|
These scalars can be visualized in plots, which appear in the ClearML [WebApp](../../../webapp/webapp_home.md), in the
|
||||||
|
experiment's **RESULTS** **>** **SCALARS** page.
|
||||||
|
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Models
|
||||||
|
|
||||||
|
ClearML automatically captures the model logged using the `megengine.save` method, and saves it as an artifact.
|
||||||
|
|
||||||
|
View saved snapshots in the experiment's **ARTIFACTS** tab.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model.
|
||||||
|
|
||||||
|
The model info panel contains the model details, including:
|
||||||
|
* Model URL
|
||||||
|
* Framework
|
||||||
|
* Snapshot locations.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Console
|
||||||
|
|
||||||
|
All console output during the script’s execution appears in the experiment’s **RESULTS > CONSOLE** page.
|
||||||
|

|
||||||
|
|
BIN
docs/img/examples_megengine_console.png
Normal file
BIN
docs/img/examples_megengine_console.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 187 KiB |
BIN
docs/img/examples_megengine_mnist_config.png
Normal file
BIN
docs/img/examples_megengine_mnist_config.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
BIN
docs/img/examples_megengine_mnist_scalars.png
Normal file
BIN
docs/img/examples_megengine_mnist_scalars.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 68 KiB |
BIN
docs/img/examples_megengine_models_1.png
Normal file
BIN
docs/img/examples_megengine_models_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
BIN
docs/img/examples_megengine_models_2.png
Normal file
BIN
docs/img/examples_megengine_models_2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 52 KiB |
@ -67,11 +67,10 @@ module.exports = {
|
|||||||
{'Frameworks': [
|
{'Frameworks': [
|
||||||
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
|
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
|
||||||
{'FastAI': ['guides/frameworks/fastai/fastai_with_tensorboard']},
|
{'FastAI': ['guides/frameworks/fastai/fastai_with_tensorboard']},
|
||||||
{
|
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
|
||||||
'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']
|
|
||||||
},
|
|
||||||
{'LightGBM': ['guides/frameworks/lightgbm/lightgbm_example']},
|
{'LightGBM': ['guides/frameworks/lightgbm/lightgbm_example']},
|
||||||
{'Matplotlib': ['guides/frameworks/matplotlib/matplotlib_example']},
|
{'Matplotlib': ['guides/frameworks/matplotlib/matplotlib_example']},
|
||||||
|
{'MegEngine':['guides/frameworks/megengine/megengine_mnist']},
|
||||||
{'PyTorch':
|
{'PyTorch':
|
||||||
['guides/frameworks/pytorch/pytorch_distributed_example', 'guides/frameworks/pytorch/pytorch_matplotlib',
|
['guides/frameworks/pytorch/pytorch_distributed_example', 'guides/frameworks/pytorch/pytorch_matplotlib',
|
||||||
'guides/frameworks/pytorch/pytorch_mnist', 'guides/frameworks/pytorch/pytorch_tensorboard', 'guides/frameworks/pytorch/pytorch_tensorboardx',
|
'guides/frameworks/pytorch/pytorch_mnist', 'guides/frameworks/pytorch/pytorch_tensorboard', 'guides/frameworks/pytorch/pytorch_tensorboardx',
|
||||||
|
Loading…
Reference in New Issue
Block a user