# Optimyzer API Client
This is the Python API Client for Optimyzer. Use it to conveniently run optimizations from Python.
To get access to the API you will need an Optimyzer account.
If you have any kind of issue or suggestion, please
drop us a line: [info@gauss-ml.com](mailto:info@gauss-ml.com).
## Getting started
Installing the `Optimyzer API Client` is very easy, just run `pip install optimyzer_api_client`
in your favorite Python environment and you're done. If you like it, you might want to add
`optimyzer_api_client` to your project's dependencies.
## Optimyzer Usage
`OptimyzerClient` has been built to be included in any kind of workflow as easily as possible.
First you have to import it:
```python
from optimyzer_api_client import OptimyzerClient
```
Then you need to create an instance using your `Optimyzer` username and password.
```python
oac = OptimyzerClient.from_login(username="your@email.com", password="AVery$ecureP@ssw0rd!")
```
You can also use a credentials file.
```python
oac = OptimyzerClient.from_credentials("/path/to/credentials_file.json")
```
Once you have an `Optimyzer API Client` instance, you can start creating machines, optimizations,
and runing them.
Check out the `notebooks` on this repository for examples on how to get started.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/gauss-ml-open/optimyzer-api-client",
"name": "optimyzer-api-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5, <4",
"maintainer_email": "",
"keywords": "parameter optimization,machine learning,artificial intelligence,neural networks",
"author": "Gauss Machine Learning GmbH",
"author_email": "info@gauss-ml.com",
"download_url": "https://files.pythonhosted.org/packages/cb/9a/a97377dd7bdfab4e9eea2607a0301d35d842b5a4ccc0ed2263514e186a68/optimyzer_api_client-0.5.1.tar.gz",
"platform": null,
"description": "# Optimyzer API Client\n\nThis is the Python API Client for Optimyzer. Use it to conveniently run optimizations from Python.\n\nTo get access to the API you will need an Optimyzer account.\n\nIf you have any kind of issue or suggestion, please\ndrop us a line: [info@gauss-ml.com](mailto:info@gauss-ml.com).\n\n## Getting started\n\nInstalling the `Optimyzer API Client` is very easy, just run `pip install optimyzer_api_client`\nin your favorite Python environment and you're done. If you like it, you might want to add\n`optimyzer_api_client` to your project's dependencies.\n\n## Optimyzer Usage\n\n`OptimyzerClient` has been built to be included in any kind of workflow as easily as possible. \n\nFirst you have to import it:\n\n```python\nfrom optimyzer_api_client import OptimyzerClient\n```\n\nThen you need to create an instance using your `Optimyzer` username and password.\n\n```python\noac = OptimyzerClient.from_login(username=\"your@email.com\", password=\"AVery$ecureP@ssw0rd!\")\n```\n\nYou can also use a credentials file.\n\n```python\noac = OptimyzerClient.from_credentials(\"/path/to/credentials_file.json\")\n```\n\nOnce you have an `Optimyzer API Client` instance, you can start creating machines, optimizations,\nand runing them.\nCheck out the `notebooks` on this repository for examples on how to get started.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "An API Client for Optimyzer",
"version": "0.5.1",
"split_keywords": [
"parameter optimization",
"machine learning",
"artificial intelligence",
"neural networks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "943a6a93af275ae8f5d0100d4ecc3590c7824cca5525b3b2c0da10ced7cd4c43",
"md5": "f41be4af073734236fb6f1c7af7fa892",
"sha256": "5021c8a2027669f4ee34d87c5fb344c733f18073f2d58bd3dfa5388e04dcab89"
},
"downloads": -1,
"filename": "optimyzer_api_client-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f41be4af073734236fb6f1c7af7fa892",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5, <4",
"size": 14077,
"upload_time": "2023-04-17T12:40:48",
"upload_time_iso_8601": "2023-04-17T12:40:48.855966Z",
"url": "https://files.pythonhosted.org/packages/94/3a/6a93af275ae8f5d0100d4ecc3590c7824cca5525b3b2c0da10ced7cd4c43/optimyzer_api_client-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb9aa97377dd7bdfab4e9eea2607a0301d35d842b5a4ccc0ed2263514e186a68",
"md5": "40d45136eadccbf64481a79497eca308",
"sha256": "16ab29f30878ef1df303f354328e8926f200384eb2a2860789aee1b756e02760"
},
"downloads": -1,
"filename": "optimyzer_api_client-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "40d45136eadccbf64481a79497eca308",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5, <4",
"size": 11695,
"upload_time": "2023-04-17T12:40:50",
"upload_time_iso_8601": "2023-04-17T12:40:50.168010Z",
"url": "https://files.pythonhosted.org/packages/cb/9a/a97377dd7bdfab4e9eea2607a0301d35d842b5a4ccc0ed2263514e186a68/optimyzer_api_client-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 12:40:50",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "gauss-ml-open",
"gitlab_project": "optimyzer-api-client",
"lcname": "optimyzer-api-client"
}
JSON