google-ngrams 0.2.0__py3-none-any.whl

google_ngrams-0.2.0.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: google_ngrams
+Version: 0.2.0
+Summary: Fetch and analyze Google Ngram data for specified word forms.
+Author-email: David Brown <dwb2@andrew.cmu.edu>
+Maintainer-email: David Brown <dwb2@andrew.cmu.edu>
+License-Expression: MIT
+Project-URL: Documentation, https://browndw.github.io/google_ngrams
+Project-URL: Homepage, https://github.com/browndw/google_ngrams
+Keywords: nlp,language
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy>=1.22
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: polars>=1.17
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+
+google_ngrams
+=======================================================================================================
+|pypi| |pypi_downloads| |tests|
+
+This package has functions for processing `Google’s Ngram repositories <http://storage.googleapis.com/books/ngrams/books/datasetsv2.html>`_ without having to download them locally. These repositories vary in their size, but the larger ones (like th one for the letter *s* or common bigrams) contain multiple gigabytes.
+
+The main function uses `scan_csv from the polars <https://docs.pola.rs/api/python/dev/reference/api/polars.scan_csv.html>`_ package to reduce memory load. Still, depending on the specific word forms being searched, loading and processing the data tables can sometimes take a few minutes if they are large.
+
+vnc
+---
+
+To analyze the returned data, the package also contains functions based on the work of Gries and Hilpert (2012) for `Variability-Based Neighbor Clustering <https://www.oxfordhandbooks.com/view/10.1093/oxfordhb/9780199922765.001.0001/oxfordhb-9780199922765-e-14>`_.
+
+The idea is to use hierarchical clustering to aid "bottom up" periodization of language change. The python functions are built on `their original R code <http://global.oup.com/us/companion.websites/fdscontent/uscompanion/us/static/companion.websites/nevalainen/Gries-Hilpert_web_final/vnc.individual.html>`_.
+
+Distances, therefore, are calculated in sums of standard deviations and coefficients of variation, according to their stated method.
+
+Dendrograms are plotted using matplotlib, with custom implementations for hierarchical clustering that maintain the plotting order of the leaves according to the requirements of the method.
+
+The package also has a custom implementation of dendrogram truncation that consolidates leaves under a specified number of time periods (or clusters) while also maintaining the leaf order to facilitate the reading and interpretation of large dendrograms.
+
+Lightweight Implementation
+--------------------------
+
+Starting with version 0.2.0, google_ngrams uses lightweight, custom implementations for statistical computations instead of heavy dependencies like scipy and statsmodels. This design choice reduces installation overhead while maintaining full functionality for the core VNC methodology and smoothing operations.
+
+
+Installation
+------------
+
+You can install the released version of google_ngrams from `PyPI <https://pypi.org/project/google_ngrams/>`_:
+
+.. code-block:: install-google_ngrams
+
+    pip install google-ngrams
+
+
+Usage
+-----
+
+To use the google_ngrams package, import :code:`google_ngram` to fetch data and :code:`TimeSeries` for analysis.
+
+.. code-block:: import
+
+    from google_ngrams import google_ngram, TimeSeries 
+
+
+Fetching n-gram data
+^^^^^^^^^^^^^^^^^^^^
+
+The :code:`google_ngram` function supports different varieties of English (e.g., British, American) and allows aggregation by year or decade. Word forms (even a single word form) must be formatted as a list:
+
+The following would return counts for the word *x-ray* in US English by year:
+
+.. code-block:: by_year
+
+    xray_year = google_ngram(word_forms = ["x-ray"], variety = "us", by = "year")
+
+Alternatively, the following would return counts of the combined forms *xray* and *xrays* in British English by decade:
+
+.. code-block:: by_decade
+
+    xray_decade = google_ngram(word_forms = ["x-ray", "x-rays"], variety = "gb", by = "decade")
+
+The function returns a polars DataFrame with either a time interval column (either :code:`Year` or :code:`Decade`) and columns for :code:`Token`, :code:`AF` (absolute frequency) and :code:`RF` (relative frequency).
+
+The returned DataFrame, then, can be manipulated using the polars API:
+
+.. code-block:: filtering
+
+    import polars as pl
+    
+    xray_filtered = xray_decade.filter(pl.col("Decade") >= 1900)
+
+
+Analyzing time series data
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To analyze the data, use :code:`TimeSeries`, specifying a column of time intervals and a column of relative frequencies:
+
+.. code-block:: time_series
+
+    xray_ts = TimeSeries(xray_filtered, time_col="Decade", values_col="RF")
+    
+VNC dendrograms can then be plotted with a variety of options:
+
+.. code-block:: dendrogram
+
+    xray_ts.timeviz_vnc()
+
+For additional information, consult the `documentation <https://browndw.github.io/google_ngrams/>`_.
+
+
+License
+-------
+
+Code licensed under `MIT License <https://opensource.org/licenses/MIT>`_.
+See `LICENSE <https://github.com/browndw/google_ngrams/blob/main/LICENSE>`_ file.
+
+.. |pypi| image:: https://badge.fury.io/py/google_ngrams.svg
+    :target: https://badge.fury.io/py/google_ngrams
+    :alt: PyPI Version
+
+.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/google_ngrams
+    :target: https://pypi.org/project/google_ngrams/
+    :alt: Downloads from PyPI
+
+.. |tests| image:: https://github.com/browndw/google_ngrams/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/browndw/google_ngrams/actions/workflows/test.yml
+    :alt: Test Status

google_ngrams-0.2.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+google_ngrams/__init__.py,sha256=01F_2COa0bIM7j6u-TM5bDQ27OPAlU_Jmz2FHRc6cTs,379
+google_ngrams/ngrams.py,sha256=cMGlZQXyE8DUPf3TPO0OYiJATLd3HNbyhxxaHYkMZNU,12192
+google_ngrams/scatter_helpers.py,sha256=JlMrUe-8PZIu68C1Yp06AH1KHb_8PLxzAbuuNcGJbEQ,5657
+google_ngrams/vnc.py,sha256=unsIZqKP4Yh3iA3vJvmKIAVvDGQUGhkuBPOKlKBcFds,17018
+google_ngrams/vnc_helpers.py,sha256=1YxN9dxAYDXIqd5KBmkWa7sz5S_LzYryYqGUaJNUKQ8,25123
+google_ngrams/data/__init__.py,sha256=HGJ8SSIb7oP17ZtqwBVE4MzrbHEkR7Wkr2yleI-qTUM,420
+google_ngrams/data/googlebooks_eng_all_totalcounts_20120701.parquet,sha256=z39hgtEE18o3qAdOc_HpFJOFCPjdgVWDef1rAbZRndQ,12000
+google_ngrams/data/googlebooks_eng_gb_all_totalcounts_20120701.parquet,sha256=oxcdjSOEFuvt19CiaD0kPapy6Z8lkij0rIDuiJuJUVc,12251
+google_ngrams/data/googlebooks_eng_us_all_totalcounts_20120701.parquet,sha256=CQi0n-vovKbKYQ7nUWEn7gerGHm8pAusGVpGIx1m9Go,11063
+google_ngrams-0.2.0.dist-info/licenses/LICENSE,sha256=gCVdJQkFNFbywKo3EZ1w6kV-Zt5jkXozXV0wWjDed1g,9122
+google_ngrams-0.2.0.dist-info/METADATA,sha256=EE4Yw3AOQCFgn_1cQGAlthgIu9el-x0pmg60nUIUq2k,6273
+google_ngrams-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+google_ngrams-0.2.0.dist-info/top_level.txt,sha256=IjVijaqC11yDFtc5yqqDR_ikNpUJT0zu_6AaDpHs0SA,14
+google_ngrams-0.2.0.dist-info/RECORD,,

google_ngrams-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

google_ngrams-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,162 @@
+MIT License
+
+Copyright (c) 2025 David Brown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

google_ngrams-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+google_ngrams