Skip to content

Commit 86a936b

Browse files
benoit-ctybenoit-cty
benoit-cty
authored and
benoit-cty
committed
Fix doc links
1 parent 59b3323 commit 86a936b

1 file changed

Lines changed: 35 additions & 35 deletions

File tree

‎docs/how-to/examples.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,91 +6,91 @@ The directory [examples/](https://github.com/mlco2/codecarbon/tree/master/exampl
66

77
| Example | Type | Description |
88
|---------|------|-------------|
9-
| [print_hardware.py](../../examples/print_hardware.py) | Python Script | Detect and display available hardware (CPU, GPU, RAM) on your system |
10-
| [command_line_tool.py](../../examples/command_line_tool.py) | Python Script | Track emissions of external command-line tools executed via subprocess |
9+
| [print_hardware.py](https://github.com/mlco2/codecarbon/blob/master/examples/print_hardware.py) | Python Script | Detect and display available hardware (CPU, GPU, RAM) on your system |
10+
| [command_line_tool.py](https://github.com/mlco2/codecarbon/blob/master/examples/command_line_tool.py) | Python Script | Track emissions of external command-line tools executed via subprocess |
1111

1212
## Tracking Methods
1313

1414
| Example | Type | Description |
1515
|---------|------|-------------|
16-
| [mnist_decorator.py](../../examples/mnist_decorator.py) | Python Script | Track emissions using the `@track_emissions` decorator on functions |
17-
| [mnist_context_manager.py](../../examples/mnist_context_manager.py) | Python Script | Track emissions using `EmissionsTracker` as a context manager (with statement) |
18-
| [mnist_callback.py](../../examples/mnist_callback.py) | Python Script | Track emissions using Keras/TensorFlow callbacks during model training |
19-
| [api_call_demo.py](../../examples/api_call_demo.py) | Python Script | Track emissions and send data to the CodeCarbon API with `@track_emissions` |
16+
| [mnist_decorator.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist_decorator.py) | Python Script | Track emissions using the `@track_emissions` decorator on functions |
17+
| [mnist_context_manager.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist_context_manager.py) | Python Script | Track emissions using `EmissionsTracker` as a context manager (with statement) |
18+
| [mnist_callback.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist_callback.py) | Python Script | Track emissions using Keras/TensorFlow callbacks during model training |
19+
| [api_call_demo.py](https://github.com/mlco2/codecarbon/blob/master/examples/api_call_demo.py) | Python Script | Track emissions and send data to the CodeCarbon API with `@track_emissions` |
2020

2121
## Basic Model Training
2222

2323
| Example | Type | Description |
2424
|---------|------|-------------|
25-
| [mnist.py](../../examples/mnist.py) | Python Script | Train a simple neural network on MNIST dataset with TensorFlow |
26-
| [mnist-sklearn.py](../../examples/mnist-sklearn.py) | Python Script | Train a scikit-learn model on MNIST and track emissions |
27-
| [pytorch-multigpu-example.py](../../examples/pytorch-multigpu-example.py) | Python Script | PyTorch CNN training on MNIST with multi-GPU support |
25+
| [mnist.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist.py) | Python Script | Train a simple neural network on MNIST dataset with TensorFlow |
26+
| [mnist-sklearn.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist-sklearn.py) | Python Script | Train a scikit-learn model on MNIST and track emissions |
27+
| [pytorch-multigpu-example.py](https://github.com/mlco2/codecarbon/blob/master/examples/pytorch-multigpu-example.py) | Python Script | PyTorch CNN training on MNIST with multi-GPU support |
2828

2929
## Hyperparameter Search
3030

3131
| Example | Type | Description |
3232
|---------|------|-------------|
33-
| [mnist_grid_search.py](../../examples/mnist_grid_search.py) | Python Script | Grid search hyperparameter optimization with emission tracking |
34-
| [mnist_random_search.py](../../examples/mnist_random_search.py) | Python Script | Random search hyperparameter optimization with emission tracking |
33+
| [mnist_grid_search.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist_grid_search.py) | Python Script | Grid search hyperparameter optimization with emission tracking |
34+
| [mnist_random_search.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist_random_search.py) | Python Script | Random search hyperparameter optimization with emission tracking |
3535

3636
## ML Model Inference
3737

3838
| Example | Type | Description |
3939
|---------|------|-------------|
40-
| [bert_inference.py](../../examples/bert_inference.py) | Python Script | BERT language model inference with task-level tracking |
41-
| [task_inference.py](../../examples/task_inference.py) | Python Script | Track emissions for different inference tasks (load dataset, build model, predict) |
42-
| [task_loop_same_task.py](../../examples/task_loop_same_task.py) | Python Script | Track emissions running the same task multiple times |
43-
| [transformers_smollm2.py](../../examples/transformers_smollm2.py) | Python Script | Small language model (SmolLM2) inference from Hugging Face |
44-
| [ollama_local_api.py](../../examples/ollama_local_api.py) | Python Script | Track emissions of local LLM API calls using Ollama |
40+
| [bert_inference.py](https://github.com/mlco2/codecarbon/blob/master/examples/bert_inference.py) | Python Script | BERT language model inference with task-level tracking |
41+
| [task_inference.py](https://github.com/mlco2/codecarbon/blob/master/examples/task_inference.py) | Python Script | Track emissions for different inference tasks (load dataset, build model, predict) |
42+
| [task_loop_same_task.py](https://github.com/mlco2/codecarbon/blob/master/examples/task_loop_same_task.py) | Python Script | Track emissions running the same task multiple times |
43+
| [transformers_smollm2.py](https://github.com/mlco2/codecarbon/blob/master/examples/transformers_smollm2.py) | Python Script | Small language model (SmolLM2) inference from Hugging Face |
44+
| [ollama_local_api.py](https://github.com/mlco2/codecarbon/blob/master/examples/ollama_local_api.py) | Python Script | Track emissions of local LLM API calls using Ollama |
4545

4646
## Hardware-Specific Examples
4747

4848
| Example | Type | Description |
4949
|---------|------|-------------|
50-
| [intel_npu.py](../../examples/intel_npu.py) | Python Script | Intel Neural Processing Unit (NPU) support for model inference |
51-
| [full_cpu.py](../../examples/full_cpu.py) | Python Script | Demonstrate full CPU utilization and emission tracking |
50+
| [intel_npu.py](https://github.com/mlco2/codecarbon/blob/master/examples/intel_npu.py) | Python Script | Intel Neural Processing Unit (NPU) support for model inference |
51+
| [full_cpu.py](https://github.com/mlco2/codecarbon/blob/master/examples/full_cpu.py) | Python Script | Demonstrate full CPU utilization and emission tracking |
5252

5353
## Parallel & Concurrent Processing
5454

5555
| Example | Type | Description |
5656
|---------|------|-------------|
57-
| [multithread.py](../../examples/multithread.py) | Python Script | Track emissions from multithreaded workloads |
58-
| [compare_cpu_load_and_RAPL.py](../../examples/compare_cpu_load_and_RAPL.py) | Python Script | Compare RAPL power measurement vs CPU load estimation in parallel workloads |
57+
| [multithread.py](https://github.com/mlco2/codecarbon/blob/master/examples/multithread.py) | Python Script | Track emissions from multithreaded workloads |
58+
| [compare_cpu_load_and_RAPL.py](https://github.com/mlco2/codecarbon/blob/master/examples/compare_cpu_load_and_RAPL.py) | Python Script | Compare RAPL power measurement vs CPU load estimation in parallel workloads |
5959

6060
## Logging & Output Integration
6161

6262
| Example | Type | Description |
6363
|---------|------|-------------|
64-
| [logging_to_file.py](../../examples/logging_to_file.py) | Python Script | Save emissions data to a local CSV file |
65-
| [logging_to_file_exclusive_run.py](../../examples/logging_to_file_exclusive_run.py) | Python Script | Long-running process with exclusive file logging |
66-
| [logging_to_google_cloud.py](../../examples/logging_to_google_cloud.py) | Python Script | Send emissions data to Google Cloud Logging |
67-
| [logfire_metrics.py](../../examples/logfire_metrics.py) | Python Script | Integrate CodeCarbon with Logfire metrics platform |
68-
| [prometheus_call.py](../../examples/prometheus_call.py) | Python Script | Export emissions metrics to Prometheus |
69-
| [mnist-comet.py](../../examples/mnist-comet.py) | Python Script | Integrate emission tracking with Comet.ml experiment tracking |
64+
| [logging_to_file.py](https://github.com/mlco2/codecarbon/blob/master/examples/logging_to_file.py) | Python Script | Save emissions data to a local CSV file |
65+
| [logging_to_file_exclusive_run.py](https://github.com/mlco2/codecarbon/blob/master/examples/logging_to_file_exclusive_run.py) | Python Script | Long-running process with exclusive file logging |
66+
| [logging_to_google_cloud.py](https://github.com/mlco2/codecarbon/blob/master/examples/logging_to_google_cloud.py) | Python Script | Send emissions data to Google Cloud Logging |
67+
| [logfire_metrics.py](https://github.com/mlco2/codecarbon/blob/master/examples/logfire_metrics.py) | Python Script | Integrate CodeCarbon with Logfire metrics platform |
68+
| [prometheus_call.py](https://github.com/mlco2/codecarbon/blob/master/examples/prometheus_call.py) | Python Script | Export emissions metrics to Prometheus |
69+
| [mnist-comet.py](https://github.com/mlco2/codecarbon/blob/master/examples/mnist-comet.py) | Python Script | Integrate emission tracking with Comet.ml experiment tracking |
7070

7171
## Metrics & Analysis
7272

7373
| Example | Type | Description |
7474
|---------|------|-------------|
75-
| [pue.py](../../examples/pue.py) | Python Script | Calculate Power Usage Effectiveness (PUE) with CodeCarbon |
76-
| [wue.py](../../examples/wue.py) | Python Script | Calculate Water Usage Effectiveness (WUE) of your computing |
75+
| [pue.py](https://github.com/mlco2/codecarbon/blob/master/examples/pue.py) | Python Script | Calculate Power Usage Effectiveness (PUE) with CodeCarbon |
76+
| [wue.py](https://github.com/mlco2/codecarbon/blob/master/examples/wue.py) | Python Script | Calculate Water Usage Effectiveness (WUE) of your computing |
7777

7878
## Interactive Notebooks
7979

8080
| Example | Type | Description |
8181
|---------|------|-------------|
82-
| [notebook.ipynb](../../examples/notebook.ipynb) | Jupyter Notebook | Basic CodeCarbon usage in Jupyter environment |
83-
| [compare_cpu_load_and_RAPL.ipynb](../../examples/compare_cpu_load_and_RAPL.ipynb) | Jupyter Notebook | Compare different power measurement methods (RAPL vs CPU load) |
84-
| [local_llms.ipynb](../../examples/local_llms.ipynb) | Jupyter Notebook | Track emissions of local LLM inference |
82+
| [notebook.ipynb](https://github.com/mlco2/codecarbon/blob/master/examples/notebook.ipynb) | Jupyter Notebook | Basic CodeCarbon usage in Jupyter environment |
83+
| [compare_cpu_load_and_RAPL.ipynb](https://github.com/mlco2/codecarbon/blob/master/examples/compare_cpu_load_and_RAPL.ipynb) | Jupyter Notebook | Compare different power measurement methods (RAPL vs CPU load) |
84+
| [local_llms.ipynb](https://github.com/mlco2/codecarbon/blob/master/examples/local_llms.ipynb) | Jupyter Notebook | Track emissions of local LLM inference |
8585

8686
## Setup & Configuration
8787

8888
| Item | Description |
8989
|------|-------------|
90-
| [requirements-examples.txt](../../examples/requirements-examples.txt) | Python dependencies for running the examples |
91-
| [rapl/](../../examples/rapl/) | Setup instructions for RAPL power measurement support |
92-
| [slurm_rocm/](../../examples/slurm_rocm/) | Configuration for SLURM job scheduler with ROCm GPU support |
93-
| [notebooks/](../../examples/notebooks/) | Additional Jupyter notebooks |
90+
| [requirements-examples.txt](https://github.com/mlco2/codecarbon/blob/master/examples/requirements-examples.txt) | Python dependencies for running the examples |
91+
| [rapl/](https://github.com/mlco2/codecarbon/blob/master/examples/rapl/) | Setup instructions for RAPL power measurement support |
92+
| [slurm_rocm/](https://github.com/mlco2/codecarbon/blob/master/examples/slurm_rocm/) | Configuration for SLURM job scheduler with ROCm GPU support |
93+
| [notebooks/](https://github.com/mlco2/codecarbon/blob/master/examples/notebooks/) | Additional Jupyter notebooks |
9494

9595
## Running the Examples
9696

0 commit comments

Comments
 (0)