| Name | holonote JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | Annotate your data |
| upload_time | 2024-09-13 08:30:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2023, HoloViz team (holoviz.org). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * Neither the name of the copyright holder nor the names of any 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 OWNER 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 |
annotation
holoviews
tools
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `holonote`
The `holonote` library offers tools to create, edit and persist
annotated regions for [HoloViews](https://holoviews.org/).
<img src="https://assets.holoviz.org/holonote/demo.gif">
An annotated region marks a region-of-interest that is overlaid on top
of the visual representation of a HoloViews element. Such a region has a
unique identifier as well as additional domain-specific information
associated with it. What `holonote` offers is a flexible way to
interactively work with these visual regions as well as tools to add,
update and delete whatever domain-specific information you want to
associate with them.
There are two primary components currently offered by `holonote`:
1. `Annotators`: These classes offer the ability to interactively define
regions, add associated domain-specific information and then persist
this information to a database. You can interactively add, delete and
update these annotation regions as well as their associated
domain-specific data.
2. `Editors`: These tools are designed to let you interactively
manipulate and edit the visual regions themselves. These regions are in
fact HoloViews elements which means you can use these editors as
generic edit tools for the corresponding HoloViews elements.
By default, annotators automatically persist any annotations you create
to a local SQLite database file. This is a very convenient way to get
started with your annotation task, allowing you to immediate begin the
process of collecting useful information.
For production usage where you are investing significant resources
authoring annotations, it is advisable that you define a custom
connector to a more appropriate database system. You can also use
connectors to load annotations from existing databases of annotation
data.
**Do not use the SQLite connector when deploying to production. It is
intended for use only during local development. It is not designed to
be particularly efficient, stable, or secure.**
## Terminology
There are two particularly important pieces of terminology that are used
throughout this library to be aware of:
1. _Regions_: These denote the visual regions-of-interest with a final
visual representation as a HoloViews element. These may be one or two
dimensional, may have different visual representations for the same data
(e.g. a point marker or a crosshair to mark a point in 2D space) and
have different types:
- _Points_: A single value of interest in an N-dimensional space. For
instance, on a time axis, this corresponds to a moment in time
which may be represented visually as a vertical line. On an image,
this can ve visually represented with a crosshair.
- _Ranges_: A range is an axis-aligned span between a start and end
point. For instance, along a time axis, this corresponds to a time interval and
on an image, this corresponds to a 2D box.
2. _Fields_: These are the domain-specific component of the annotation
data, containing information that is not to be visualized by
`holonote`. These are defined by the user or application and can have
arbitrary types and contents. A complete set of fields together with one
or more regions constitutes an annotation.
Raw data
{
"_id": null,
"home_page": null,
"name": "holonote",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "annotation, holoviews, tools",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a4/d6/15cf7cafce740de859b5497ee5c07f2fe47b61db45df84b8dec4c8a6a7dd/holonote-0.2.1.tar.gz",
"platform": null,
"description": "# `holonote`\n\nThe `holonote` library offers tools to create, edit and persist\nannotated regions for [HoloViews](https://holoviews.org/).\n\n<img src=\"https://assets.holoviz.org/holonote/demo.gif\">\n\nAn annotated region marks a region-of-interest that is overlaid on top\nof the visual representation of a HoloViews element. Such a region has a\nunique identifier as well as additional domain-specific information\nassociated with it. What `holonote` offers is a flexible way to\ninteractively work with these visual regions as well as tools to add,\nupdate and delete whatever domain-specific information you want to\nassociate with them.\n\nThere are two primary components currently offered by `holonote`:\n\n1. `Annotators`: These classes offer the ability to interactively define\n regions, add associated domain-specific information and then persist\n this information to a database. You can interactively add, delete and\n update these annotation regions as well as their associated\n domain-specific data.\n\n2. `Editors`: These tools are designed to let you interactively\n manipulate and edit the visual regions themselves. These regions are in\n fact HoloViews elements which means you can use these editors as\n generic edit tools for the corresponding HoloViews elements.\n\nBy default, annotators automatically persist any annotations you create\nto a local SQLite database file. This is a very convenient way to get\nstarted with your annotation task, allowing you to immediate begin the\nprocess of collecting useful information.\n\nFor production usage where you are investing significant resources\nauthoring annotations, it is advisable that you define a custom\nconnector to a more appropriate database system. You can also use\nconnectors to load annotations from existing databases of annotation\ndata.\n\n**Do not use the SQLite connector when deploying to production. It is\nintended for use only during local development. It is not designed to\nbe particularly efficient, stable, or secure.**\n\n## Terminology\n\nThere are two particularly important pieces of terminology that are used\nthroughout this library to be aware of:\n\n1. _Regions_: These denote the visual regions-of-interest with a final\n visual representation as a HoloViews element. These may be one or two\n dimensional, may have different visual representations for the same data\n (e.g. a point marker or a crosshair to mark a point in 2D space) and\n have different types:\n\n- _Points_: A single value of interest in an N-dimensional space. For\n instance, on a time axis, this corresponds to a moment in time\n which may be represented visually as a vertical line. On an image,\n this can ve visually represented with a crosshair.\n- _Ranges_: A range is an axis-aligned span between a start and end\n point. For instance, along a time axis, this corresponds to a time interval and\n on an image, this corresponds to a 2D box.\n\n2. _Fields_: These are the domain-specific component of the annotation\n data, containing information that is not to be visualized by\n `holonote`. These are defined by the user or application and can have\n arbitrary types and contents. A complete set of fields together with one\n or more regions constitutes an annotation.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023, HoloViz team (holoviz.org). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * Neither the name of the copyright holder nor the names of any 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 OWNER 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": "Annotate your data",
"version": "0.2.1",
"project_urls": null,
"split_keywords": [
"annotation",
" holoviews",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b718c7f5bd22429341671f38ec0ea5e5a0c3c67c185924b520e5155fbe5d1151",
"md5": "652e92216081f90c64aa89c9146ea82c",
"sha256": "76dee1939cfcdcee6e07f8e490ec7bf2915570dd2633e6c6f0182c08b1cf68b5"
},
"downloads": -1,
"filename": "holonote-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "652e92216081f90c64aa89c9146ea82c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 51590,
"upload_time": "2024-09-13T08:30:03",
"upload_time_iso_8601": "2024-09-13T08:30:03.578192Z",
"url": "https://files.pythonhosted.org/packages/b7/18/c7f5bd22429341671f38ec0ea5e5a0c3c67c185924b520e5155fbe5d1151/holonote-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4d615cf7cafce740de859b5497ee5c07f2fe47b61db45df84b8dec4c8a6a7dd",
"md5": "e700fad50798289d7fee9925afa403c1",
"sha256": "3477f17d8d52b7e7d1244af2a80b02c006524af0063f686a4759734d83924be2"
},
"downloads": -1,
"filename": "holonote-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "e700fad50798289d7fee9925afa403c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 44045,
"upload_time": "2024-09-13T08:30:05",
"upload_time_iso_8601": "2024-09-13T08:30:05.081605Z",
"url": "https://files.pythonhosted.org/packages/a4/d6/15cf7cafce740de859b5497ee5c07f2fe47b61db45df84b8dec4c8a6a7dd/holonote-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 08:30:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "holonote"
}
