temporal-mapper


Nametemporal-mapper JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-10-06 21:07:45
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseCopyright (c) 2024, Kaleb Ruscitti, Leland McInnes 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 mapper tda morse theory temporal topic modeling
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img
align="left" width="200" height="120" 
src="./docs/icon.png" alt="Temporal Mapper Logo">
## Temporal Mapper

### V.1.0.0 - October 06 '24
-----------------------------------------------
This is a library for using the Mapper for temporal topic modelling.
Though things broadly work now, the edge cases have not been throughly 
tested.

Direct questions to Kaleb D. Ruscitti: kaleb.ruscitti at uwaterloo.ca .

Complete documentation is under construction on [Read The Docs](
https://temporal-mapper.readthedocs.io/en/latest/).

### Example:
#### arXiv Papers 
From the arXiv API, we can retrieve ~500,000 article titles and abstracts,
use `SBERT` to embed them, and then UMAP to reduce to 2D.

Using [DataMapPlot](https://github.com/tutteinstitute/datamapplot) and
[TopicNaming](https://github.com/tutteinstitute/topicnaming) we can
produce a static plot of this data:

![A DataMapPlot of ArXiV papers](./doc/arxiv_static.png 
"A DataMapPlot of ArXiV Papers")

Now, using this repository we can additionally analyse the temporal
information. Using the Mapper algorithm with time as our lens
function, we create a *temporal graph* of the topics (clusters)
through time. The code includes two types of plots to visualize this
graph:

Centroid Plot             |  Temporal-Semantic Plot
:-------------------------:|:-------------------------:
![](./docs/arxiv_centroids.png)  |  ![](./docs/arxiv_time.png)

### Installation
Clone the repo and install: 
`git clone https://github.com/TutteInstitute/temporal-mapper.git`
`cd temporal-mapper && pip install .`

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "temporal-mapper",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Mapper, TDA, Morse Theory, Temporal Topic Modeling",
    "author": null,
    "author_email": "Kaleb D Ruscitti <kaleb.ruscitti@uwaterloo.ca>",
    "download_url": "https://files.pythonhosted.org/packages/c7/f8/5d0cbbd315aa4dd4e13916a0c49a0367056257a110a693f550e88c6c3e6f/temporal_mapper-1.0.0.tar.gz",
    "platform": null,
    "description": "<img\nalign=\"left\" width=\"200\" height=\"120\" \nsrc=\"./docs/icon.png\" alt=\"Temporal Mapper Logo\">\n## Temporal Mapper\n\n### V.1.0.0 - October 06 '24\n-----------------------------------------------\nThis is a library for using the Mapper for temporal topic modelling.\nThough things broadly work now, the edge cases have not been throughly \ntested.\n\nDirect questions to Kaleb D. Ruscitti: kaleb.ruscitti at uwaterloo.ca .\n\nComplete documentation is under construction on [Read The Docs](\nhttps://temporal-mapper.readthedocs.io/en/latest/).\n\n### Example:\n#### arXiv Papers \nFrom the arXiv API, we can retrieve ~500,000 article titles and abstracts,\nuse `SBERT` to embed them, and then UMAP to reduce to 2D.\n\nUsing [DataMapPlot](https://github.com/tutteinstitute/datamapplot) and\n[TopicNaming](https://github.com/tutteinstitute/topicnaming) we can\nproduce a static plot of this data:\n\n![A DataMapPlot of ArXiV papers](./doc/arxiv_static.png \n\"A DataMapPlot of ArXiV Papers\")\n\nNow, using this repository we can additionally analyse the temporal\ninformation. Using the Mapper algorithm with time as our lens\nfunction, we create a *temporal graph* of the topics (clusters)\nthrough time. The code includes two types of plots to visualize this\ngraph:\n\nCentroid Plot             |  Temporal-Semantic Plot\n:-------------------------:|:-------------------------:\n![](./docs/arxiv_centroids.png)  |  ![](./docs/arxiv_time.png)\n\n### Installation\nClone the repo and install: \n`git clone https://github.com/TutteInstitute/temporal-mapper.git`\n`cd temporal-mapper && pip install .`\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2024, Kaleb Ruscitti, Leland McInnes 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": null,
    "version": "1.0.0",
    "project_urls": null,
    "split_keywords": [
        "mapper",
        " tda",
        " morse theory",
        " temporal topic modeling"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a9195834495cb63cdc8fa55d11041d427ba5f23f5a616ed422a3e031e23fd6b",
                "md5": "100384aacf418e99242a401a47fc210f",
                "sha256": "ff1e2c03fabd4ce2807d14026b99d266410853a5b8111a2944f69b7821b0ce79"
            },
            "downloads": -1,
            "filename": "temporal_mapper-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "100384aacf418e99242a401a47fc210f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15459,
            "upload_time": "2024-10-06T21:07:43",
            "upload_time_iso_8601": "2024-10-06T21:07:43.311637Z",
            "url": "https://files.pythonhosted.org/packages/0a/91/95834495cb63cdc8fa55d11041d427ba5f23f5a616ed422a3e031e23fd6b/temporal_mapper-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c7f85d0cbbd315aa4dd4e13916a0c49a0367056257a110a693f550e88c6c3e6f",
                "md5": "0d1dd26dd51574d122c825924c3025da",
                "sha256": "9b1324d0a4e97e2a3934297540eb5632f2558dd9a45c5e117620fbfd873e29fb"
            },
            "downloads": -1,
            "filename": "temporal_mapper-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0d1dd26dd51574d122c825924c3025da",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13462,
            "upload_time": "2024-10-06T21:07:45",
            "upload_time_iso_8601": "2024-10-06T21:07:45.913392Z",
            "url": "https://files.pythonhosted.org/packages/c7/f8/5d0cbbd315aa4dd4e13916a0c49a0367056257a110a693f550e88c6c3e6f/temporal_mapper-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-06 21:07:45",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "temporal-mapper"
}
        
Elapsed time: 0.76754s