muellerzr HF staff commited on
Commit
7576dfc
1 Parent(s): 5e55606

Include better doc links that align with the TOC

Browse files
code_samples/calculating_metrics CHANGED
@@ -46,5 +46,6 @@ that all tensors have the same length. This ensures that the metric is calculate
46
  ##
47
  To learn more checkout the related documentation:
48
 
49
- - <a href="https://huggingface.co/docs/accelerate/v0.15.0/package_reference/accelerator#accelerate.Accelerator.gather_for_metrics" target="_blank">API reference</a>
 
50
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/multi_process_metrics.py" target="_blank">Example script</a>
 
46
  ##
47
  To learn more checkout the related documentation:
48
 
49
+ - <a href="https://huggingface.co/docs/accelerate/en/quicktour#distributed-evaluation" target="_blank">Quicktour - Calculating metrics</a>
50
+ - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.gather_for_metrics" target="_blank">API reference</a>
51
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/multi_process_metrics.py" target="_blank">Example script</a>
code_samples/checkpointing CHANGED
@@ -23,6 +23,7 @@ any custom registered objects from the main process on each device to a passed i
23
  **This API is designed to save and resume training states only from within the same python script or training setup.**
24
  ##
25
  To learn more checkout the related documentation:
26
- - <a href="https://huggingface.co/docs/accelerate/v0.15.0/package_reference/accelerator#accelerate.Accelerator.save_state" target="_blank">`save_state` reference</a>
27
- - <a href="https://huggingface.co/docs/accelerate/v0.15.0/package_reference/accelerator#accelerate.Accelerator.load_state" target="_blank">`load_state` reference</a>
 
28
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/checkpointing.py" target="_blank">Example script</a>
 
23
  **This API is designed to save and resume training states only from within the same python script or training setup.**
24
  ##
25
  To learn more checkout the related documentation:
26
+ - <a href="https://huggingface.co/docs/accelerate/usage_guides/checkpoint" target="_blank">Saving and loading training states</a>
27
+ - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.save_state" target="_blank">`save_state` API reference</a>
28
+ - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.load_state" target="_blank">`load_state` API reference</a>
29
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/checkpointing.py" target="_blank">Example script</a>
code_samples/experiment_tracking CHANGED
@@ -27,6 +27,6 @@ At the end of training call `accelerator.end_training()` to call any finalizatio
27
  may need automatically.
28
  ##
29
  To learn more checkout the related documentation:
30
- - <a href="https://huggingface.co/docs/accelerate/usage_guides/tracking" target="_blank">Basic Tutorial</a>
31
  - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.log" target="_blank">Accelerator API Reference</a>
32
  - <a href="https://huggingface.co/docs/accelerate/package_reference/tracking" target="_blank">Tracking API Reference</a>
 
27
  may need automatically.
28
  ##
29
  To learn more checkout the related documentation:
30
+ - <a href="https://huggingface.co/docs/accelerate/usage_guides/tracking" target="_blank">Using experiment trackers</a>
31
  - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.log" target="_blank">Accelerator API Reference</a>
32
  - <a href="https://huggingface.co/docs/accelerate/package_reference/tracking" target="_blank">Tracking API Reference</a>
code_samples/gradient_accumulation CHANGED
@@ -27,6 +27,7 @@ automatically when needed.
27
 
28
  ##
29
  To learn more checkout the related documentation:
 
30
  - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.accumulate" target="_blank">API reference</a>
31
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/gradient_accumulation.py" target="_blank">Example script</a>
32
- - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/automatic_gradient_accumulation.py" target="_blank">Performing automatic gradient accumulation</a>
 
27
 
28
  ##
29
  To learn more checkout the related documentation:
30
+ - <a href="https://huggingface.co/docs/accelerate/usage_guides/gradient_accumulation" target="_blank">Performing gradient accumulation</a>
31
  - <a href="https://huggingface.co/docs/accelerate/package_reference/accelerator#accelerate.Accelerator.accumulate" target="_blank">API reference</a>
32
  - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/gradient_accumulation.py" target="_blank">Example script</a>
33
+ - <a href="https://github.com/huggingface/accelerate/blob/main/examples/by_feature/automatic_gradient_accumulation.py" target="_blank">Performing automatic gradient accumulation example script</a>