{"id":18300451,"url":"https://github.com/comet-ml/comet-java-sdk","last_synced_at":"2025-07-23T21:05:29.120Z","repository":{"id":37907386,"uuid":"166427031","full_name":"comet-ml/comet-java-sdk","owner":"comet-ml","description":"Comet Java SDK ","archived":false,"fork":false,"pushed_at":"2023-03-31T15:17:12.000Z","size":11669,"stargazers_count":4,"open_issues_count":1,"forks_count":6,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-06-11T20:17:29.578Z","etag":null,"topics":["comet-java-sdk","comet-ml","java","java-sdk","java-sdk-download","machine-learning","sdk","sdk-api","sdk-examples"],"latest_commit_sha":null,"homepage":"https://www.comet.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/comet-ml.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-18T15:36:36.000Z","updated_at":"2022-09-22T21:17:51.000Z","dependencies_parsed_at":"2022-08-18T13:13:16.892Z","dependency_job_id":null,"html_url":"https://github.com/comet-ml/comet-java-sdk","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcomet-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcomet-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcomet-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comet-ml%2Fcomet-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comet-ml","download_url":"https://codeload.github.com/comet-ml/comet-java-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223192520,"owners_count":17103564,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comet-java-sdk","comet-ml","java","java-sdk","java-sdk-download","machine-learning","sdk","sdk-api","sdk-examples"],"created_at":"2024-11-05T15:12:30.989Z","updated_at":"2024-11-05T15:12:31.856Z","avatar_url":"https://github.com/comet-ml.png","language":"Java","readme":"# https://www.comet.com official Java SDK    \n[![version](https://img.shields.io/github/v/tag/comet-ml/comet-java-sdk.svg?sort=semver)](https://github.com/comet-ml/comet-java-sdk/releases/latest) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/ml.comet/comet-java-client/badge.svg)](https://maven-badges.herokuapp.com/maven-central/ml.comet/comet-java-client) [![license](https://img.shields.io/github/license/comet-ml/comet-java-sdk.svg)](https://github.com/comet-ml/comet-java-sdk/blob/master/LICENSE) [![javadoc](https://javadoc.io/badge2/ml.comet/comet-java-client/javadoc.svg)](https://javadoc.io/doc/ml.comet/comet-java-client) \n\n| Branch | Tests                                                                                      | Coverage                                                                                                                             | Linting                                                                    | Code Security                                                                    |\n|--------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| master | [![CI](https://github.com/comet-ml/comet-java-sdk/actions/workflows/ci-maven.yml/badge.svg)](https://github.com/comet-ml/comet-java-sdk/workflows/ci-maven.yml) | [![codecov](https://codecov.io/gh/comet-ml/comet-java-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/comet-ml/comet-java-sdk) | [![Lint Code Base](https://github.com/comet-ml/comet-java-sdk/actions/workflows/super-linter.yml/badge.svg)](https://github.com/comet-ml/comet-java-sdk/actions/workflows/super-linter.yml) | [![CodeQL](https://github.com/comet-ml/comet-java-sdk/actions/workflows/codeQL.yml/badge.svg)](https://github.com/comet-ml/comet-java-sdk/actions/workflows/codeQL.yml) |\n\n## Using Comet Java SDK\n### Add dependency to the pom.xml\n```\n    \u003cdependencies\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003eml.comet\u003c/groupId\u003e\n            \u003cartifactId\u003ecomet-java-client\u003c/artifactId\u003e\n            \u003cversion\u003e1.1.14\u003c/version\u003e\n        \u003c/dependency\u003e\n    \u003c/dependencies\u003e\n```\n### Create experiment and log metrics and parameters\n```java\nOnlineExperiment experiment = ExperimentBuilder.OnlineExperiment()\n                .withApiKey(\"someApiKey\")\n                .withProjectName(\"someProject\")\n                .withWorkspace(\"someWorkspace\")\n                .build();\n    experiment.setExperimentName(\"My experiment\");\n    experiment.logParameter(\"batch_size\", \"500\");\n    experiment.logMetric(\"strMetric\", 123);\n    experiment.end();\n```\nThe ```OnlineExperiment``` also can be used with [try-with-resources](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html) statement which automatically\nhandles call to the ```experiment.end()```.\n```java\ntry (OnlineExperiment experiment = ExperimentBuilder.OnlineExperiment()\n                .withApiKey(\"someApiKey\")\n                .withProjectName(\"someProject\")\n                .withWorkspace(\"someWorkspace\")\n                .build()) {\n    experiment.setExperimentName(\"My experiment\");\n    experiment.logParameter(\"batch_size\", \"500\");\n    experiment.logMetric(\"strMetric\", 123);\n} catch (Exception e) {\n    e.printStackTrace();\n}\n```\n\n### Configure experiment object\n\n#### Configuration sources hierarchy\n\nThe configuration parameters search order as following (first-listed are higher priority):\n * system properties or environment variables\n * configuration file set by call to [```withConfigOverride(java.io.File)```](comet-java-client/src/main/java/ml/comet/experiment/builder/BaseCometBuilder.java)\n * ```application.conf``` (all resources on the classpath with this name)\n * ```reference.conf``` (all resources on the classpath with this name)\n \n#### Programmatic configuration\n\nIt is possible to override some or all configuration parameters programmatically when \nyou create a new experiment's instance using [```ExperimentBuilder```](comet-java-client/src/main/java/ml/comet/experiment/ExperimentBuilder.java)\nfactory.\n```java\n// Setting specific configuration parameters with builder\nExperimentBuilder.OnlineExperiment().withApiKey(\"someApiKey\").build();\n\n// Override configuration file (can have partial keys)\nExperimentBuilder.OnlineExperiment().withConfigOverride(new File(\"/tmp/comet.conf\")).build();\n\n// Read from environment variables OR from configuration file in classpath (application.conf)\nExperimentBuilder.OnlineExperiment().build();\n```\n\n### Full list of environment variables\n```text\nCOMET_API_KEY\nCOMET_PROJECT_NAME\nCOMET_WORKSPACE_NAME\nCOMET_BASE_URL\nCOMET_MAX_AUTH_RETRIES\n```\n\n### Examples\n\n* You also can check \n  * [Sample Online Experiment](comet-examples/src/main/java/ml/comet/examples/OnlineExperimentExample.java)\n  * [MNIST classification experiment](comet-examples/src/main/java/ml/comet/examples/mnist/MnistExperimentExample.java)\n  * [Comet artifact examples](comet-examples/src/main/java/ml/comet/examples/ArtifactExample.java)\n  * [Log model example](comet-examples/src/main/java/ml/comet/examples/LogModelExample.java)\n  * [Model registry/Comet API example](comet-examples/src/main/java/ml/comet/examples/RegistryModelExample.java)\n  * [Comet API example](comet-examples/src/main/java/ml/comet/examples/ApiExamples.java)\n* For more usage examples refer to [tests](comet-java-client/src/test/java/ml/comet/experiment)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomet-ml%2Fcomet-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomet-ml%2Fcomet-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomet-ml%2Fcomet-java-sdk/lists"}