texiv

A machine learning–based package for transforming text into instrumental variables (IV).

https://github.com/sepinetam/texiv

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary

Keywords

econometrics instrumental-variables iv iv-2sls machine-learning stata texiv
Last synced: 6 months ago · JSON representation ·

Repository

A machine learning–based package for transforming text into instrumental variables (IV).

Basic Info
  • Host: GitHub
  • Owner: SepineTam
  • License: agpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 3.29 MB
Statistics
  • Stars: 3
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 11
Topics
econometrics instrumental-variables iv iv-2sls machine-learning stata texiv
Created 8 months ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

TexIV Logo


A machine learning–based package for transforming text into instrumental variables (IV).

PythonMin StataMin PyPI version PyPI Downloads License: AGPL v3 Issue release Wiki Ask DeepWiki


🌰 Example

Visit Stata Example File and Python Example File.

There is a step-by-step example.

✨ Feature

  • Support multiple Chinese word segmentation and embedding methods
  • Customizable stopwords
  • Support keyword relevance filtering and two-stage filtering
  • Output includes frequency, total count, and ratio statistics

📦 Requirements

  • Python 3.11+
  • Recommended to use virtual environment (e.g., venv or conda)

🚀 Quickly Start

Install

bash pip install texiv

Usage

```python from typing import List

from texiv import TexIV

texiv = TexIV() content: str = "This is a test text..." keywords: List[str] = ["keyword1", "keyword2", "keyword3"] texiv.texiv_it(content, keywords) ```

Output example:

{'freq': 7, 'count': 34, 'rate': 0.20588235294117646}

🖥️ Command Line Tool

The project also provides a command-line interface that can be used directly after installation:

bash texiv --help

🛠️ Configuration

All models and parameters can be adjusted through configuration files in ~/.texiv/config.toml.

📄 License

This project is licensed under the GNU Affero General Public License v3.0. See LICENSE for details.

Note: Commercial use requires compliance with AGPL-3.0 terms, including source code disclosure for network services.

Owner

  • Login: SepineTam
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "A machine learning–based method for transforming text into instrumental variables (IV)."
authors:
  - family-names: "Tan"
    given-names: "Song"
    email: "sepinetam@gmail.com"
title: "TexIV: A machine learning–based method for transforming text into instrumental variables (IV)."
version: 0.1.10
date-released: 2025-07-17
url: "https://github.com/sepinetam/texiv"
repository-code: "https://github.com/sepinetam/texiv"
license: MIT

GitHub Events

Total
  • Release event: 9
  • Watch event: 2
  • Delete event: 1
  • Push event: 44
  • Pull request event: 5
  • Create event: 15
Last Year
  • Release event: 9
  • Watch event: 2
  • Delete event: 1
  • Push event: 44
  • Pull request event: 5
  • Create event: 15

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 961 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
  • Total maintainers: 1
pypi.org: texiv

A machine learning–based method for transforming text into instrumental variables (IV).

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 961 Last month
Rankings
Dependent packages count: 8.9%
Average: 29.6%
Dependent repos count: 50.2%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/labels.yml actions
  • EndBug/label-sync v2 composite
  • actions/checkout v3 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/pytest.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/release.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • astral-sh/setup-uv v3 composite
pyproject.toml pypi
  • jieba >=0.42.1
  • numpy >=2.3.1
  • ollama >=0.5.1
  • openai >=1.93.0
  • toml >=0.10.2
  • tomlkit >=0.13.3
uv.lock pypi
  • annotated-types 0.7.0
  • anyio 4.9.0
  • certifi 2025.6.15
  • colorama 0.4.6
  • distro 1.9.0
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.10
  • jieba 0.42.1
  • jiter 0.10.0
  • numpy 2.3.1
  • ollama 0.5.1
  • openai 1.93.0
  • pydantic 2.11.7
  • pydantic-core 2.33.2
  • sniffio 1.3.1
  • texiv 0.1.0
  • toml 0.10.2
  • tomlkit 0.13.3
  • tqdm 4.67.1
  • typing-extensions 4.14.0
  • typing-inspection 0.4.1
.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/init v3 composite