https://github.com/neuml/tldrstory
📊 Semantic search for headlines and story text
https://github.com/neuml/tldrstory
machine-learning nlp python search txtai
Last synced: 7 months ago
JSON representation
📊 Semantic search for headlines and story text
- Host: GitHub
- URL: https://github.com/neuml/tldrstory
- Owner: neuml
- License: apache-2.0
- Created: 2020-10-05T16:19:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-23T13:08:32.000Z (about 2 years ago)
- Last Synced: 2024-09-24T01:14:16.417Z (about 1 year ago)
- Topics: machine-learning, nlp, python, search, txtai
- Language: Python
- Homepage:
- Size: 24.6 MB
- Stars: 355
- Watchers: 16
- Forks: 27
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Semantic search for headlines and story text
-------------------------------------------------------------------------------------------------------------------------------------------------------
tldrstory is a semantic search application for headlines and text content related to stories. tldrstory applies zero-shot labeling over text, which allows dynamically categorizing content. This framework also builds a txtai index that enables text similarity search. A customizable Streamlit application and FastAPI backend service allows users to review and analyze the data processed.
tldrstory has a corresponding [Medium article](https://towardsdatascience.com/tldrstory-ai-powered-understanding-of-headlines-and-story-text-fc86abd702fc) that covers the concepts in this README and more. Check it out!
## Examples
The following links are example applications built with tldrstory.
- [Mobile Tech News](https://github.com/neuml/tldrstory/tree/master/apps/devices)
- [Sports News](https://github.com/neuml/tldrstory/tree/master/apps/sports)
## Installation
The easiest way to install is via pip and PyPI
pip install tldrstory
You can also install tldrstory directly from GitHub. Using a Python Virtual Environment is recommended.
pip install git+https://github.com/neuml/tldrstory
Python 3.8+ is supported
See [this link](https://github.com/neuml/txtai#installation) to help resolve environment-specific install issues.
## Configurating an application
Once installed, an application must be configured to run. A tldrstory application consists of three separate processes:
- Indexing
- API backend
- Streamlit application
This section will show how to start the "Sports News" application.
1. Download the “Sports News” application configuration.
```bash
mkdir sports
wget https://raw.githubusercontent.com/neuml/tldrstory/master/apps/sports/app.yml -O sports/app.yml
wget https://raw.githubusercontent.com/neuml/tldrstory/master/apps/sports/api.yml -O sports/api.yml
wget https://raw.githubusercontent.com/neuml/tldrstory/master/apps/sports/index-simple.yml -O sports/index.yml
wget https://raw.githubusercontent.com/neuml/tldrstory/master/src/python/tldrstory/app.py -O sports/app.py
```
2. Start the indexing process.
```bash
python -m tldrstory.index sports/index.yml
```
3. Start the API process.
```bash
CONFIG=sports/api.yml API_CLASS=tldrstory.api.API uvicorn "txtai.api:app" &
```
4. Start Streamlit.
```bash
streamlit run sports/app.py sports/app.yml "Sports" "🏆"
```
5. Open a web browser and go to http://localhost:8501
## Custom Sources
Out of the box, tldrstory supports reading data from RSS and the Reddit API. Additional data sources can be defined and configured.
The following shows an example custom data source definition. [neuspo](https://neuspo.com) is a real-time sports event and news application.
This data source loads 4 pre-defined entries into the articles database.
```python
from tldrstory.source.source import Source
class Neuspo(Source):
"""
Articles have the following schema:
uid - unique id
source - source name
date - article date
title - article title
url - reference url for data
entry - entry date
"""
def run(self):
# List of articles created
articles = []
articles.append(self.article("0", "Neuspo", self.now(), "Eagles defeat the Giants 22 - 21",
"https://neuspo.com/stream/34952e3919d685982c17735018b0197f", self.now()))
articles.append(self.article("1", "Neuspo", self.now(), "Giants lose to the Eagles 22 - 21",
"https://t.co/e9FFgo0wgR?amp=1", self.now()))
articles.append(self.article("2", "Neuspo", self.now(), "Rays beat Dodgers 6 to 4",
"https://neuspo.com/stream/6cb820b3ebadc086aa36b5cc4a0f575d", self.now()))
articles.append(self.article("3", "Neuspo", self.now(), "Dodgers drop Game 2, 6-4",
"https://t.co/1hEQAShVnP?amp=1", self.now()))
return articles
```
Let’s re-run the steps above using neuspo as the data source. First remove the sports/data directory, to ensure we create a fresh database. We can then download the gist above into the sports directory.
```bash
# Delete the sports/data directory before running
wget https://gist.githubusercontent.com/davidmezzetti/9a6064d9a741acb89bd46eba9f906c26/raw/7058e97da82571005b2654b4ab908f25b9a04fe2/neuspo.py -O sports/neuspo.py
```
Edit sports/index.yml and remove the rss section. Replace it with the following.
```yaml
# Custom data source for neuspo
source: sports.neuspo.Neuspo
```
Now re-run steps 2–4 from the [instructions above](#configurating-an-application).
## Parameter Reference
The following sections define configuration parameters for each process that is part of a tldrstory application.
## Indexing
Configures the indexing of content. Currently supports pulling data via the Reddit API, RSS and custom user-defined sources.
### name
```yaml
name: string
```
Application name
### schedule
```yaml
schedule: string
```
Cron-style string that enables scheduled running of the indexing job. See [this link](https://en.wikipedia.org/wiki/Cron) for more information on cron strings.
### sources
Data source configuration.
#### reddit
```yaml
reddit.subreddit: name of subreddit to pull from
reddit.sort: sort type
reddit.time: time range
reddit.queries: list of text queries to run
```
Runs a series of Reddit API queries. A Reddit API key will need to be created and configured for this method to work. Authentication parameters can be set within the enviroment or in a praw.ini file. See [this link](https://praw.readthedocs.io/en/latest/getting_started/quick_start.html) for more information on setting up a Reddit API account, read-only access is all that is needed.
See [PRAW documentation](https://praw.readthedocs.io/en/latest/code_overview/models/subreddit.html) for more details on how to configure the query settings.
#### rss
```yaml
rss: list of RSS urls
```
Reads a series of RSS feeds and builds articles for each article link found.
#### source
```yaml
source: string
```
Configures a custom source. This parameter takes a full class path as a string, for example "tldrstory.source.rss.RSS"
Custom sources can be use any data that has a date, text string and reference url. See the documentation in [source.py](https://github.com/neuml/tldrstory/blob/master/src/python/tldrstory/source/source.py) for information on how to create a custom source. [rss.py](https://github.com/neuml/tldrstory/blob/master/src/python/tldrstory/source/rss.py) and [reddit.py](https://github.com/neuml/tldrstory/blob/master/src/python/tldrstory/source/reddit.py) are example implementations.
### ignore
```yaml
ignore: list of url patterns
```
List of url patterns to ignore. Supports strings and regular expressions.
### labels
```yaml
labels: dict
```
Label configuration for zero-shot classifier. This configuration sets a category along with a list of topic values.
Example:
```yaml
labels:
topic:
values: [Label 1, Label 2]
```
The example above configures the category "Topic" with two possible labels, "Label 1" and "Label 2". Any label can be set here and a large-scale
NLP model will be used to categorize input text into those labels.
### path
```yaml
path: string
```
Where to store model output, path will be created if it doesn't already exist.
### embeddings
```yaml
embeddings: dict
```
Configures a txtai index used for searching topics. See [txtai configuration](https://github.com/neuml/txtai#configuration) for more details on this.
## API
Configures a FastAPI backed interface for pulling indexed data.
### path
```yaml
path: string
```
Path to a model index.
## Application
The default application is powered by Streamlit and driven by a YAML configuration file. The configuration file sets the application name, API endpoint for pulling content, and component configuration. A custom Streamlit application or any other application can be used in place of this to pull content from the API endpoint directly.
### name
```yaml
name: string
```
Application name
### api
```yaml
api: url
```
API endpoint for pulling content.
### layout
```yaml
description: string
```
Markdown string that is used to build a sidebar description.
#### queries
```yaml
queries.name: Queries drop down header
queries.values: List of values to use for queries drop down
```
Configures the query drop down box. This should be a list of pre-canned queries to use. If a value of "Latest" is present, it will query for the last N
articles. If a value of "--Search--" is present, it will present another text box to allow entering custom queries.
#### filters
```yaml
filters: list
```
List of slider filters. This should map to the zero-shot labels configured in the indexing section.
#### chart
```yaml
chart.name: Chart name
chart.x: Chart x-axis column
chart.y: Chart y-axis column
chart.scale: Color scale for list of colors
chart.colors: List of colors
```
Allows configuration of a scatter plot that graphs two label points. This chart can be used to plot and apply coloring to applied labels.
#### table
```yaml
"column name": dynamic range of coloring
```
Data table that shows result details. In addition to default columns, this section allows adding additional columns based on the zero-shot
labels applied. The default mode is to show the numeric value of the label but a range of text labels can also be applied.
For example:
- [0, 5.0, Label 1, "color: #F00"]
- [5.0, 10.0, Label 2, "color: #0F0"]
The above would output the text "Label 1" in red for values between 0 and 5. Values between 5 and 10 would output the text "Label 2" in green.