use-ml-training 0.0.1

Training run and hyperparameter metadata primitives for RustUse.
Documentation
  • Coverage
  • 1.23%
    1 out of 81 items documented1 out of 33 items with examples
  • Size
  • Source code size: 13.12 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.42 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 3s Average build duration of successful builds.
  • all releases: 3s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • RustUse/use-ml
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • CloudBranch

use-ml-training

Training run and hyperparameter metadata primitives for RustUse.

Experimental

use-ml-training is experimental while use-ml remains below 0.3.0.

Example

use use_ml_training::{MlBatchSize, MlLearningRate, MlOptimizerKind, MlTrainingRunId};

let run_id = MlTrainingRunId::new("run-001")?;
let batch_size = MlBatchSize::new(32)?;
let learning_rate = MlLearningRate::new(0.001)?;
let optimizer: MlOptimizerKind = "adamw".parse()?;

assert_eq!(run_id.as_str(), "run-001");
assert_eq!(batch_size.get(), 32);
assert_eq!(learning_rate.value(), 0.001);
assert_eq!(optimizer, MlOptimizerKind::AdamW);
# Ok::<(), use_ml_training::MlTrainingError>(())

Scope

  • Training run IDs, job names, status, phases, optimizer labels, and loss labels.
  • Positive batch sizes and epoch counts.
  • Finite positive learning rates and hyperparameter names/values.

Non-goals

  • Performing training, tuning, checkpointing, or model export.
  • Agent training loops, prompt optimization, RLHF, RLAIF, or instruction-tuning-specific APIs in v0.1.

License

Licensed under either Apache-2.0 or MIT.