News Signals
Example Colab Notebooks
These notebooks let you try out news-signals without installing anything!
- Find Emerging Categories in a Newsfeed - Video
- Searching the Aylien NewsAPI Using An Entity Name - Video
- An Overview of News Signals Datasets - Video
The Colab notebooks above are also available as jupyter notebooks in research/news-signals-example-notebooks
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.
1 maintainer
Release files for news-signals 0.2.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| news-signals-0.2.9.tar.gz | 929.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| news_signals-0.2.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 985.1 kB
Release files / news-signals-0.2.9.tar.gz
| Download URL | news-signals-0.2.9.tar.gz |
|---|---|
| Size | 929.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
855cc7e470f355b9a4f5e883b01a35c5401b681eb6a5451442c3e252b1e3ab70
|
|
BLAKE2b-256 checksum How to use checksums |
6b3d18e03c657e5035a9f355dafbbd909fa66df34b07808bc16da538fcd23090
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / news_signals-0.2.9-py3-none-any.whl
| Download URL | news_signals-0.2.9-py3-none-any.whl |
|---|---|
| Size | 55.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cfb49cce59feab36c532ff7fd54ec79483ca841d9ca07b87ed779b818fde2dfb
|
|
BLAKE2b-256 checksum How to use checksums |
16c9f735d574ab6c463a946bd2fbdda979581fdc75480dbc238ac78a330c3a27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
