{
    "info": {
        "author": "Faculty",
        "author_email": "opensource@faculty.ai",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "faculty-models\n==============\n\n``faculty-models`` is a tool to help you use models from the model registry in\nFaculty Platform.\n\n.. warning::\n\n    This library's API is subject to change as new functionality is added to\n    the model registry feature in Faculty Platform.\n\nInstallation\n------------\n\n``faculty-models`` comes preinstalled in Python environments available in\nFaculty platform. To use it externally, install it from PyPI with ``pip``:\n\n.. code-block:: bash\n\n    pip install faculty-models\n\nIf you've not already done so on the computer you're using, you'll also need to\ngenerate and store CLI credentials for the Platform. You can do this with\n`the Faculty CLI\n<https://docs.faculty.ai/user-guide/command_line_interface.html#initialising-faculty>`_.\n\nUsage\n-----\n\nThe model registry in Faculty Platform includes a feature that helps you\ngenerate the snippets you need. It will help you get the project and model IDs\nyou need to use ``faculty-models``.\n\nIf your model is in the `MLmodel format\n<https://mlflow.org/docs/latest/models.html>`_ (likely because you used `MLflow\n<https://mlflow.org/>`_ to store it), you can load it directly back into Python\nwith:\n\n.. code-block:: python\n\n    import faculty_models\n\n    model = faculty_models.load_mlmodel(\n        project_id=\"998328c3-23df-4225-a3ee-0a53d1409fbd\",\n        model_id=\"c998fca9-e093-47ea-9896-8f75db695b91\"\n    )\n\nOtherwise, you can use the following to download the contents of the model to\nthe local filesystem. ``download`` returns the path of the downloaded model\nfiles:\n\n.. code-block:: python\n\n    import faculty_models\n\n    path = faculty_models.download(\n        project_id=\"998328c3-23df-4225-a3ee-0a53d1409fbd\",\n        model_id=\"c998fca9-e093-47ea-9896-8f75db695b91\"\n    )\n\nThe above examples always download the latest version of a model. To get a\nspecific verion, pass the version number when calling either function:\n\n.. code-block:: python\n\n    import faculty_models\n\n    model = faculty_models.load_mlmodel(\n        project_id=\"998328c3-23df-4225-a3ee-0a53d1409fbd\",\n        model_id=\"c998fca9-e093-47ea-9896-8f75db695b91\",\n        version=4\n    )\n\nIf you only wish to download part of the model, or if you wish to load an\nMLmodel that is in a subdirectory of the model, pass the path argument to\neither function:\n\n.. code-block:: python\n\n    import faculty_models\n\n    model = faculty_models.load_mlmodel(\n        project_id=\"998328c3-23df-4225-a3ee-0a53d1409fbd\",\n        model_id=\"c998fca9-e093-47ea-9896-8f75db695b91\",\n        path=\"sub/path\"\n    )\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://faculty.ai/products-services/platform/",
        "keywords": "",
        "license": "Apache Software License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "faculty-models",
        "package_url": "https://pypi.org/project/faculty-models/",
        "platform": "",
        "project_url": "https://pypi.org/project/faculty-models/",
        "project_urls": {
            "Homepage": "https://faculty.ai/products-services/platform/"
        },
        "release_url": "https://pypi.org/project/faculty-models/0.1.0/",
        "requires_dist": [
            "faculty (>=0.25.4)",
            "mlflow (==1.2.0)"
        ],
        "requires_python": "",
        "summary": "Python library for retrieving models from Faculty platform.",
        "version": "0.1.0"
    },
    "last_serial": 5917714,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d9dda1a0744a594a982853728c468919",
                    "sha256": "f6a13857606c07f38be668ffec1f94b207abac088449b6140746a30de27102c8"
                },
                "downloads": -1,
                "filename": "faculty_models-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d9dda1a0744a594a982853728c468919",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 7605,
                "upload_time": "2019-10-02T12:42:36",
                "url": "https://files.pythonhosted.org/packages/b2/35/1524bb2635299e35e496fac8164ae77ae75b804118ba80d11f520efd071e/faculty_models-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7d6a3b27fc3e511c646aac479dd43d3a",
                    "sha256": "be9a44bb206e1c2c44c05a0b6a94e586dbb3c2b28511d65ea30c02629e8b6df6"
                },
                "downloads": -1,
                "filename": "faculty-models-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "7d6a3b27fc3e511c646aac479dd43d3a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8150,
                "upload_time": "2019-10-02T12:42:39",
                "url": "https://files.pythonhosted.org/packages/f1/4e/f5d52ad86ab4df33d2486af5871c558c6905cba2e461d56a434b7d8cdb85/faculty-models-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d9dda1a0744a594a982853728c468919",
                "sha256": "f6a13857606c07f38be668ffec1f94b207abac088449b6140746a30de27102c8"
            },
            "downloads": -1,
            "filename": "faculty_models-0.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d9dda1a0744a594a982853728c468919",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 7605,
            "upload_time": "2019-10-02T12:42:36",
            "url": "https://files.pythonhosted.org/packages/b2/35/1524bb2635299e35e496fac8164ae77ae75b804118ba80d11f520efd071e/faculty_models-0.1.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7d6a3b27fc3e511c646aac479dd43d3a",
                "sha256": "be9a44bb206e1c2c44c05a0b6a94e586dbb3c2b28511d65ea30c02629e8b6df6"
            },
            "downloads": -1,
            "filename": "faculty-models-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7d6a3b27fc3e511c646aac479dd43d3a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8150,
            "upload_time": "2019-10-02T12:42:39",
            "url": "https://files.pythonhosted.org/packages/f1/4e/f5d52ad86ab4df33d2486af5871c558c6905cba2e461d56a434b7d8cdb85/faculty-models-0.1.0.tar.gz"
        }
    ]
}