fiddy


Namefiddy JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryFinite difference methods
upload_time2024-10-15 08:57:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseBSD 3-Clause License Copyright (c) 2022, fiddy developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords finite difference gradient check difference quotient
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # fiddy

[![Test suite](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml/badge.svg)](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml)
[![PyPI](https://badge.fury.io/py/fiddy.svg)](https://badge.fury.io/py/fiddy)
[![Documentation](https://readthedocs.org/projects/fiddy/badge/?version=latest)](https://fiddy.readthedocs.io)

[Finite difference methods](https://en.wikipedia.org/wiki/Finite_difference),
for applications including gradient computation and gradient checks.

# Important notes

The output of your function of interest should be a NumPy array. If your function is scalar-valued, change it to a NumPy array with:
```python
import numpy as np

def function(input_value: float) -> np.ndarray:
    scalar_output_value = old_function(input_value)
    return np.array([scalar_output_value])
```

# Installation

Currently under development, please install from source.
```bash
pip install -e .
```

Can also be installed from [PyPI](https://pypi.org/project/fiddy/)
```bash
pip install fiddy
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fiddy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "finite difference, gradient check, difference quotient",
    "author": null,
    "author_email": "The fiddy developers <dilan.pathirana@uni-bonn.de>",
    "download_url": "https://files.pythonhosted.org/packages/d0/1e/e4a95028ef387fe4ee7e3880db8309f50fb5f8439a84165fb322b87bd791/fiddy-0.0.2.tar.gz",
    "platform": null,
    "description": "# fiddy\n\n[![Test suite](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml/badge.svg)](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml)\n[![PyPI](https://badge.fury.io/py/fiddy.svg)](https://badge.fury.io/py/fiddy)\n[![Documentation](https://readthedocs.org/projects/fiddy/badge/?version=latest)](https://fiddy.readthedocs.io)\n\n[Finite difference methods](https://en.wikipedia.org/wiki/Finite_difference),\nfor applications including gradient computation and gradient checks.\n\n# Important notes\n\nThe output of your function of interest should be a NumPy array. If your function is scalar-valued, change it to a NumPy array with:\n```python\nimport numpy as np\n\ndef function(input_value: float) -> np.ndarray:\n    scalar_output_value = old_function(input_value)\n    return np.array([scalar_output_value])\n```\n\n# Installation\n\nCurrently under development, please install from source.\n```bash\npip install -e .\n```\n\nCan also be installed from [PyPI](https://pypi.org/project/fiddy/)\n```bash\npip install fiddy\n```\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2022, fiddy developers All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Finite difference methods",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/icb-dcm/fiddy/issues",
        "Documentation": "https://fiddy.readthedocs.io",
        "Homepage": "https://github.com/icb-dcm/fiddy",
        "Repository": "https://github.com/icb-dcm/fiddy"
    },
    "split_keywords": [
        "finite difference",
        " gradient check",
        " difference quotient"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d01ee4a95028ef387fe4ee7e3880db8309f50fb5f8439a84165fb322b87bd791",
                "md5": "0afc2f42461ba0bd686ded5b8c3336b4",
                "sha256": "94cae761f590cb0d5152dcf1ef14b603f657d7e2d2ce77e70c34ec598d83a72b"
            },
            "downloads": -1,
            "filename": "fiddy-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0afc2f42461ba0bd686ded5b8c3336b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 34302,
            "upload_time": "2024-10-15T08:57:10",
            "upload_time_iso_8601": "2024-10-15T08:57:10.030455Z",
            "url": "https://files.pythonhosted.org/packages/d0/1e/e4a95028ef387fe4ee7e3880db8309f50fb5f8439a84165fb322b87bd791/fiddy-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 08:57:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "icb-dcm",
    "github_project": "fiddy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "fiddy"
}
None
Elapsed time: 0.45822s