Skip to main content

Citation style classifier

Project description

Citation style classifier

Citation style classifier can automatically infer citation style from a reference string. The classifier is a Logistic Regression model trained on 90,000 reference strings. The following citation styles are supported by default:

  • acm-sig-proceedings
  • american-chemical-society
  • american-chemical-society-with-titles
  • american-institute-of-physics
  • american-sociological-association
  • apa
  • bmc-bioinformatics
  • chicago-author-date
  • elsevier-without-titles
  • elsevier-with-titles
  • harvard3
  • ieee
  • iso690-author-date-en
  • modern-language-association
  • springer-basic-author-date
  • springer-lecture-notes-in-computer-science
  • vancouver
  • unknown

The package contains the training data, the classification model, and the code for feature extraction, selection, training and prediction.

Installation

    pip3 install styleclass

Classification

From command line:

    styleclass_classify -r "reference string"
    styleclass_classify -i /file/with/reference/strings/one/per/line -o /output/file

In Python code:

    from styleclass.classify import classify
    from styleclass.train import get_default_model

    model = get_default_model()
    prediction = classify("reference string", *model)
    prediction = classify(["reference string #1", "reference string #2", "reference string #3"], *model)

Data

Styleclass package contains two datasets: training set and test set. Each of them contains a sample of 5,000 DOIs formatted in 17 citation styles (listed above), which gives 85,000 reference strings. Both datasets were generated automatically using Crossref REST API.

A new dataset can be generated using the script styleclass_generate_dataset.

Models

The default model was trained on the training dataset. Before the training, the dataset was cleaned and enriched with random noise. 5,000 strings with "unknown" style were also generated and added to the dataset.

Script styleclass_train_model can be used to train a new model. This is useful especially when you need to operate of a different set of citation styles than our default. The script prepares the data for training in the same was as was done for training of the default model.

Evaluation

styleclass_evaluate script can be used to evaluate exisitng model on a test set, in terms of accuracy.

The accuracy of the default model estimated on our test set is 95%.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

styleclass-0.0.5.tar.gz (5.9 MB view details)

Uploaded Source

Built Distribution

styleclass-0.0.5-py3-none-any.whl (5.9 MB view details)

Uploaded Python 3

File details

Details for the file styleclass-0.0.5.tar.gz.

File metadata

  • Download URL: styleclass-0.0.5.tar.gz
  • Upload date:
  • Size: 5.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for styleclass-0.0.5.tar.gz
Algorithm Hash digest
SHA256 f4674a719549a435beb98ef6b8c23c23d4ac47473aaa7cdfd68dfb18a1167d2a
MD5 dd39f4a47bd6997bf7eca5a6ba96bc3b
BLAKE2b-256 ac01009f912b04e27bfeede7f7fb3112bdfeb8f5bf18938f454d872559be31e5

See more details on using hashes here.

File details

Details for the file styleclass-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: styleclass-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for styleclass-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 34cae3f586548e021a2120e8574abdd4f5ce50c365ceb8d5d2d19c964bf18907
MD5 76f5f7ed6153e2db4e260c0e74656424
BLAKE2b-256 cbbc240ca0bbded515eeae2c9596a9a900120d4a2f02352462028f8af563b59c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page