A library for working with text and timeseries data.
Project description
News Signals
Example Colab Notebooks
These notebooks let you try out news-signals
without installing anything!
The Colab notebooks below are also available as jupyter notebooks in research/news-signals-example-notebooks
- Create a Signals Dataset from a CSV of Entity Names
- Find Emerging Categories in a Newsfeed - Video
- Searching the Aylien NewsAPI Using An Entity Name - Video
- An Overview of News Signals Datasets - Video
2023-11-30: NEW: Create_Wikimedia_Signals.ipynb shows how to build and explore a WikimediaSignal
which does require not a NewsAPI account and works out-of-the-box for anyone.
Quickstart
Install news-signals in a new environment
conda create -n test-signals-pypi python=3.8
conda activate test-signals-pypi
pip install news-signals
Look at a sample dataset
Do pip install jupyter
in your environment,
then run the code below in a jupyter notebook or in in the (i)python repl.
from news_signals.signals_dataset import SignalsDataset
# nasdaq100 sample dataset
dataset_url = 'https://drive.google.com/uc?id=150mfU2YA4ScfTlJvO6Duzto4aT_Q7K3D'
dataset = SignalsDataset.load(dataset_url)
Now try:
import matplotlib.pyplot as plt
fig = dataset.plot()
plt.show()
See the API Documentation for more info.
Installation from source
Install news-signals in a new environment
Run conda create -n news-signals python=3.8
if you're using Anaconda, alternatively python3.8 -m venv news-signals
or similar.
Note python>=3.8 is required.
source activate news-signals
git clone https://github.com/AYLIEN/news-signals-datasets.git
cd news-signals-datasets
pip install -r requirements.txt
pip install -e . # install in editable mode
make test # run tests
Setting up Aylien NewsAPI credentials
The news-signals library looks for environment variables called
'NEWSAPI_APP_ID'
and 'NEWSAPI_APP_KEY'
- these are used to authenticate to the NewsAPI.
One way to set these variables up for local development is to
Put your Aylien NewsAPI credentials in a file called ~/.aylienconfig
.aylienconfig
app-id=<your-app-id>
app-key=<your-app-key>
Then put the following in your .bashrc
or similar shell config file:
export NEWSAPI_APP_ID=$(cat ~/.aylienconfig | grep "app-id" | cut -d'=' -f2)
export NEWSAPI_APP_KEY=$(cat ~/.aylienconfig| grep "app-key" | cut -d'=' -f2)
Generating a new Dataset
Generate a new signals dataset as follows:
make create-dataset DATASET_CONFIG=resources/dataset-config-example.json
The config file specifies all relevant settings for a dataset, e.g. time range. Some examples that we used to create our provided example datasets:
A more detailed guide on generating new datasets is here: dataset-generation.md
Anomaly Classification Experiments
These currently live here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for news_signals-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae1bfa8e76f2a989468f17560d831bf9c04a652eac471611b22d28b540d6be74 |
|
MD5 | 8f576f07ff680e3fb7a1e60a074c8a36 |
|
BLAKE2b-256 | 09e0771061a8562f5c79d923af3ca5edd89783de0368c770495797c4a16dae41 |