{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "f341fb11f7f5d77a4974ba8273c4cd55d67c21f0",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "# SimCLR Trainer API\n\nThis module contains the implementation of a SimCLR trainer that can be used to train a model using the SimCLR approach.\n\n**Classes**\n\n| Name | Description |\n| --- | --- |\n| `SimCLRTrainer` | A trainer for SimCLR |",
      "name": "simclr",
      "path": "helia_edge.trainers.simclr",
      "submodules": [],
      "summary": "SimCLR Trainer API",
      "symbols": [
        {
          "description": "Creates a SimCLRTrainer.\n\nIf no projector is provided, a default one will be created based on paper.\n\n\n\nBase class: [ContrastiveTrainer](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer).\n\nInherited from [ContrastiveTrainer](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer): [call()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.call), [fit()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.fit), [linear_probe()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.linear_probe), [run_augmenters()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.run_augmenters), [save()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.save), [test_step()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.test_step), [train_step()](/helia-edge/reference/api/helia_edge/trainers/contrastive/#helia_edge.trainers.contrastive.ContrastiveTrainer.train_step).",
          "examples": [],
          "id": "helia_edge.trainers.simclr.SimCLRTrainer",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "helia_edge.trainers.simclr.SimCLRTrainer.compile",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "compile",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "compile(\n    encoder_optimizer: keras.Optimizer,\n    encoder_loss: keras.Loss | None = None,\n    encoder_metrics: list[keras.Metric] | None = None,\n    probe_optimizer: keras.Optimizer | None = None,\n    probe_loss: keras.Loss | None = None,\n    probe_metrics: list[keras.Metric] | None = None,\n    **kwargs={},\n)",
              "source": {
                "line": 53,
                "path": "helia_edge/trainers/simclr.py",
                "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/trainers/simclr.py#L53"
              },
              "summary": ""
            }
          ],
          "name": "SimCLRTrainer",
          "params": [
            {
              "description": "The encoder model.",
              "name": "encoder",
              "type": "keras.Model"
            },
            {
              "default": "None",
              "description": "The projector model. Defaults to None.",
              "name": "projector",
              "type": "keras.Model"
            }
          ],
          "raises": [],
          "returns": [],
          "signature": "SimCLRTrainer(encoder: keras.Model, projector: keras.Model | None = None, **kwargs={})",
          "source": {
            "line": 17,
            "path": "helia_edge/trainers/simclr.py",
            "url": "https://github.com/AmbiqAI/helia-edge/blob/f341fb11f7f5d77a4974ba8273c4cd55d67c21f0/helia_edge/trainers/simclr.py#L17"
          },
          "summary": "Creates a SimCLRTrainer."
        }
      ]
    }
  ],
  "name": "helia_edge"
}