azure-mgmt-batchai


Nameazure-mgmt-batchai JSON
Version 2.0.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure Batch AI Management Client Library for Python
upload_time2018-06-12 15:44:19
maintainer
docs_urlNone
authorMicrosoft Corporation
requires_python
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            Microsoft Azure SDK for Python
==============================

This is the Microsoft Azure Batch AI Management Client Library.

Azure Resource Manager (ARM) is the next generation of management APIs that
replace the old Azure Service Management (ASM).

This package has been tested with Python 2.7, 3.4, 3.5 and 3.6.

For the older Azure Service Management (ASM) libraries, see
`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.

For a more complete set of Azure libraries, see the `azure <https://pypi.python.org/pypi/azure>`__ bundle package.


Compatibility
=============

**IMPORTANT**: If you have an earlier version of the azure package
(version < 1.0), you should uninstall it before installing this package.

You can check the version using pip:

.. code:: shell

    pip freeze

If you see azure==0.11.0 (or any version below 1.0), uninstall it first:

.. code:: shell

    pip uninstall azure


Usage
=====

For code examples, see `Batch AI Management
<https://docs.microsoft.com/python/api/overview/azure/batchai>`__
on docs.microsoft.com.


Provide Feedback
================

If you encounter any bugs or have suggestions, please file an issue in the
`Issues <https://github.com/Azure/azure-sdk-for-python/issues>`__
section of the project.


.. :changelog:

Release History
===============

2.0.0 (2018-06-07)
++++++++++++++++++

**Breaking changes**

This version uses 2018-05-01 BatchAI API specification which introduced the following braking changes:

- Clusters, FileServers must be created under a workspace;
- Jobs must be created under an experiment;
- Clusters, FileServers and Jobs do not accept location during creation and belong to the same location as the parent
  workspace;
- Clusters, FileServers and Jobs do not support tags;
- BatchAIManagementClient.usage renamed to BatchAIManagementClient.usages;
- Job priority changed a type from int to an enum;
- File.is_directory is replaced with File.file_type;
- Job.priority and JobCreateParameters.priority is replaced with scheduling_priority;
- Removed unsupported MountSettings.file_server_type attribute;
- OutputDirectory.type unsupported attribute removed;
- OutputDirectory.create_new attributes removed, BatchAI will always create output directories if they not exist;
- SetupTask.run_elevated attribute removed, the setup task is always executed under root.

**Features**

- Added support to workspaces to group Clusters, FileServers and Experiments and remove limit on number of allocated
  resources;
- Added support for experiment to group jobs and remove limit on number of jobs;
- Added support for configuring /dev/shm for jobs which use docker containers;
- Added first class support for generic MPI jobs;
- Added first class support for Horovod jobs.

1.0.1 (2018-04-16)
++++++++++++++++++

**Bugfixes**

- Fix some invalid models in Python 3
- Compatibility of the sdist with wheel 0.31.0

1.0.0 (2018-03-19)
++++++++++++++++++

**General Breaking changes**

This version uses a next-generation code generator that *might* introduce breaking changes.

- Model signatures now use only keyword-argument syntax. All positional arguments must be re-written as keyword-arguments.
  To keep auto-completion in most cases, models are now generated for Python 2 and Python 3. Python 3 uses the "*" syntax for keyword-only arguments.
- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered.
  While this is not a breaking change, the distinctions are important, and are documented here:
  https://docs.python.org/3/library/enum.html#others
  At a glance:

  - "is" should not be used at all.
  - "format" will return the string value, where "%s" string formatting will return `NameOfEnum.stringvalue`. Format syntax should be prefered.

- New Long Running Operation:

  - Return type changes from `msrestazure.azure_operation.AzureOperationPoller` to `msrest.polling.LROPoller`. External API is the same.
  - Return type is now **always** a `msrest.polling.LROPoller`, regardless of the optional parameters used.
  - The behavior has changed when using `raw=True`. Instead of returning the initial call result as `ClientRawResponse`, 
    without polling, now this returns an LROPoller. After polling, the final resource will be returned as a `ClientRawResponse`.
  - New `polling` parameter. The default behavior is `Polling=True` which will poll using ARM algorithm. When `Polling=False`,
    the response of the initial call will be returned without polling.
  - `polling` parameter accepts instances of subclasses of `msrest.polling.PollingMethod`.
  - `add_done_callback` will no longer raise if called after polling is finished, but will instead execute the callback right away.

**Features**

- added support for job level mounting
- added support for environment variables with secret values
- added support for performance counters reporting in Azure Application Insights
- added support for custom images
- added support for pyTorch deep learning framework
- added API for usage and limits reporting
- added API for listing job files in subdirectories
- now user can choose caching type during NFS creation
- get cluster now reports a path segment generated for storing start task output logs
- get job now reports a path segment generated for job's output directories
- renamed EnvironmentSetting to EnvironmentVariable

0.2.0 (2017-10-05)
++++++++++++++++++

* credentials_info property got renamed to credentials.
* removed unused class FileServerStatus and Code enum
* renamed enums for CachingType and VmPriority
* removed 'statuses' attribute on FileServer

0.1.0 (2017-10-03)
++++++++++++++++++

* Initial Release



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-batchai",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Microsoft Corporation",
    "author_email": "azpysdkhelp@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/fa/7f/0a9e5aa22ea91db0771c267c4815396516177702a4a4eea389eed7af47dd/azure-mgmt-batchai-2.0.0.zip",
    "platform": "",
    "description": "Microsoft Azure SDK for Python\n==============================\n\nThis is the Microsoft Azure Batch AI Management Client Library.\n\nAzure Resource Manager (ARM) is the next generation of management APIs that\nreplace the old Azure Service Management (ASM).\n\nThis package has been tested with Python 2.7, 3.4, 3.5 and 3.6.\n\nFor the older Azure Service Management (ASM) libraries, see\n`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.\n\nFor a more complete set of Azure libraries, see the `azure <https://pypi.python.org/pypi/azure>`__ bundle package.\n\n\nCompatibility\n=============\n\n**IMPORTANT**: If you have an earlier version of the azure package\n(version < 1.0), you should uninstall it before installing this package.\n\nYou can check the version using pip:\n\n.. code:: shell\n\n    pip freeze\n\nIf you see azure==0.11.0 (or any version below 1.0), uninstall it first:\n\n.. code:: shell\n\n    pip uninstall azure\n\n\nUsage\n=====\n\nFor code examples, see `Batch AI Management\n<https://docs.microsoft.com/python/api/overview/azure/batchai>`__\non docs.microsoft.com.\n\n\nProvide Feedback\n================\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n`Issues <https://github.com/Azure/azure-sdk-for-python/issues>`__\nsection of the project.\n\n\n.. :changelog:\n\nRelease History\n===============\n\n2.0.0 (2018-06-07)\n++++++++++++++++++\n\n**Breaking changes**\n\nThis version uses 2018-05-01 BatchAI API specification which introduced the following braking changes:\n\n- Clusters, FileServers must be created under a workspace;\n- Jobs must be created under an experiment;\n- Clusters, FileServers and Jobs do not accept location during creation and belong to the same location as the parent\n  workspace;\n- Clusters, FileServers and Jobs do not support tags;\n- BatchAIManagementClient.usage renamed to BatchAIManagementClient.usages;\n- Job priority changed a type from int to an enum;\n- File.is_directory is replaced with File.file_type;\n- Job.priority and JobCreateParameters.priority is replaced with scheduling_priority;\n- Removed unsupported MountSettings.file_server_type attribute;\n- OutputDirectory.type unsupported attribute removed;\n- OutputDirectory.create_new attributes removed, BatchAI will always create output directories if they not exist;\n- SetupTask.run_elevated attribute removed, the setup task is always executed under root.\n\n**Features**\n\n- Added support to workspaces to group Clusters, FileServers and Experiments and remove limit on number of allocated\n  resources;\n- Added support for experiment to group jobs and remove limit on number of jobs;\n- Added support for configuring /dev/shm for jobs which use docker containers;\n- Added first class support for generic MPI jobs;\n- Added first class support for Horovod jobs.\n\n1.0.1 (2018-04-16)\n++++++++++++++++++\n\n**Bugfixes**\n\n- Fix some invalid models in Python 3\n- Compatibility of the sdist with wheel 0.31.0\n\n1.0.0 (2018-03-19)\n++++++++++++++++++\n\n**General Breaking changes**\n\nThis version uses a next-generation code generator that *might* introduce breaking changes.\n\n- Model signatures now use only keyword-argument syntax. All positional arguments must be re-written as keyword-arguments.\n  To keep auto-completion in most cases, models are now generated for Python 2 and Python 3. Python 3 uses the \"*\" syntax for keyword-only arguments.\n- Enum types now use the \"str\" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered.\n  While this is not a breaking change, the distinctions are important, and are documented here:\n  https://docs.python.org/3/library/enum.html#others\n  At a glance:\n\n  - \"is\" should not be used at all.\n  - \"format\" will return the string value, where \"%s\" string formatting will return `NameOfEnum.stringvalue`. Format syntax should be prefered.\n\n- New Long Running Operation:\n\n  - Return type changes from `msrestazure.azure_operation.AzureOperationPoller` to `msrest.polling.LROPoller`. External API is the same.\n  - Return type is now **always** a `msrest.polling.LROPoller`, regardless of the optional parameters used.\n  - The behavior has changed when using `raw=True`. Instead of returning the initial call result as `ClientRawResponse`, \n    without polling, now this returns an LROPoller. After polling, the final resource will be returned as a `ClientRawResponse`.\n  - New `polling` parameter. The default behavior is `Polling=True` which will poll using ARM algorithm. When `Polling=False`,\n    the response of the initial call will be returned without polling.\n  - `polling` parameter accepts instances of subclasses of `msrest.polling.PollingMethod`.\n  - `add_done_callback` will no longer raise if called after polling is finished, but will instead execute the callback right away.\n\n**Features**\n\n- added support for job level mounting\n- added support for environment variables with secret values\n- added support for performance counters reporting in Azure Application Insights\n- added support for custom images\n- added support for pyTorch deep learning framework\n- added API for usage and limits reporting\n- added API for listing job files in subdirectories\n- now user can choose caching type during NFS creation\n- get cluster now reports a path segment generated for storing start task output logs\n- get job now reports a path segment generated for job's output directories\n- renamed EnvironmentSetting to EnvironmentVariable\n\n0.2.0 (2017-10-05)\n++++++++++++++++++\n\n* credentials_info property got renamed to credentials.\n* removed unused class FileServerStatus and Code enum\n* renamed enums for CachingType and VmPriority\n* removed 'statuses' attribute on FileServer\n\n0.1.0 (2017-10-03)\n++++++++++++++++++\n\n* Initial Release\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure Batch AI Management Client Library for Python",
    "version": "2.0.0",
    "project_urls": {
        "Homepage": "https://github.com/Azure/azure-sdk-for-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9a5ab796c2a490155c14f9ac4240724ca5c56723315d4dc753030712e6f2e80",
                "md5": "6b33a615409a5db4051ebdaca97b9a4e",
                "sha256": "b5f7df6a77fde0bd6b486762eb2c81750b6f1730ee1116689d2dfbd3e03dba95"
            },
            "downloads": -1,
            "filename": "azure_mgmt_batchai-2.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b33a615409a5db4051ebdaca97b9a4e",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 174283,
            "upload_time": "2018-06-12T15:44:17",
            "upload_time_iso_8601": "2018-06-12T15:44:17.999081Z",
            "url": "https://files.pythonhosted.org/packages/d9/a5/ab796c2a490155c14f9ac4240724ca5c56723315d4dc753030712e6f2e80/azure_mgmt_batchai-2.0.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa7f0a9e5aa22ea91db0771c267c4815396516177702a4a4eea389eed7af47dd",
                "md5": "6235495fa4c83bac95d7c84699b02a3f",
                "sha256": "f1870b0f97d5001cdb66208e5a236c9717a0ed18b34dbfdb238a828f3ca2a683"
            },
            "downloads": -1,
            "filename": "azure-mgmt-batchai-2.0.0.zip",
            "has_sig": false,
            "md5_digest": "6235495fa4c83bac95d7c84699b02a3f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 185352,
            "upload_time": "2018-06-12T15:44:19",
            "upload_time_iso_8601": "2018-06-12T15:44:19.396398Z",
            "url": "https://files.pythonhosted.org/packages/fa/7f/0a9e5aa22ea91db0771c267c4815396516177702a4a4eea389eed7af47dd/azure-mgmt-batchai-2.0.0.zip",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2018-06-12 15:44:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Azure",
    "github_project": "azure-sdk-for-python",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "azure-mgmt-batchai"
}
        
Elapsed time: 0.06389s