Invenio-Classifier
Invenio module for record classification.
- Free software: GPLv2 license
- Documentation: https://pythonhosted.org/invenio-classifier
Features
Classifier automatically extracts keywords from fulltext documents. The automatic assignment of keywords to textual documents has clear benefits in the digital library environment as it aids catalogization, classification and retrieval of documents.
Keyword extraction is simple
Note: Classifier requires Python RDFLib in order to process the RDF/SKOS taxonomy.
In order to extract relevant keywords from a document fulltext.pdf
based on a controlled vocabulary thesaurus.rdf, you would run
Classifier as follows:
${INVENIO_WEB_INSTANCE} classifier extract -k thesaurus.rdf -f fulltext.pdf
Launching ${INVENIO_WEB_INSTANCE} classifier --help shows the options available.
As an example, running classifier on document
nucl-th/0204033 using the
high-energy physics RDF/SKOS taxonomy (HEP.rdf) would yield the
following results (based on the HEP taxonomy from October 10th 2008):
Input file: 0204033.pdf
Author keywords:
Dense matter
Saturation
Unstable nuclei
Composite keywords:
10 nucleus: stability [36, 14]
6 saturation: density [25, 31]
6 energy: symmetry [35, 11]
4 nucleon: density [13, 31]
3 energy: Coulomb [35, 3]
2 energy: density [35, 31]
2 nuclear matter: asymmetry [21, 2]
1 n: matter [54, 36]
1 n: density [54, 31]
1 n: mass [54, 16]
Single keywords:
61 K0
23 equation of state
12 slope
4 mass number
4 nuclide
3 nuclear model
3 mass formula
2 charge distribution
2 elastic scattering
2 binding energy
Thesaurus
Classifier performs an extraction of keywords based on the recurrence of specific terms, taken from a controlled vocabulary. A controlled vocabulary is a thesaurus of all the terms that are relevant in a specific context. When a context is defined by a discipline or branch of knowledge then the vocabulary is said to be a subject thesaurus. Various existing subject thesauri can be found here.
A subject thesaurus can be expressed in several different formats. Different institutions/disciplines have developed different ways of representing their vocabulary systems. The taxonomy used by classifier is expressed in RDF/SKOS. It allows not only to list keywords but to specify relations between the keywords and alternative ways to represent the same keyword.
<Concept rdf:about="http://cern.ch/thesauri/HEP.rdf#scalar">
<composite rdf:resource="http://cern.ch/thesauri/HEP.rdf#Composite.fieldtheoryscalar"/>
<prefLabel xml:lang="en">scalar</prefLabel>
<note xml:lang="en">nostandalone</note>
</Concept>
<Concept rdf:about="http://cern.ch/thesauri/HEP.rdf#fieldtheory">
<composite rdf:resource="http://cern.ch/thesauri/HEP.rdf#Composite.fieldtheoryscalar"/>
<prefLabel xml:lang="en">field theory</prefLabel>
<altLabel xml:lang="en">QFT</altLabel>
<hiddenLabel xml:lang="en">/field theor\w*/</hiddenLabel>
<note xml:lang="en">nostandalone</note>
</Concept>
<Concept rdf:about="http://cern.ch/thesauri/HEP.rdf#Composite.fieldtheoryscalar">
<compositeOf rdf:resource="http://cern.ch/thesauri/HEP.rdf#scalar"/>
<compositeOf rdf:resource="http://cern.ch/thesauri/HEP.rdf#fieldtheory"/>
<prefLabel xml:lang="en">field theory: scalar</prefLabel>
<altLabel xml:lang="en">scalar field</altLabel>
</Concept>
In RDF/SKOS, every keyword is wrapped around a concept which encapsulates the full semantics and hierarchical status of a term - including synonyms, alternative forms, broader concepts, notes and so on
- rather than just a plain keyword.
The specification of the SKOS language and various manuals that aid the building of a semantic thesaurus can be found at the SKOS W3C website. Furthermore, Classifier can function on top of an extended version of SKOS, which includes special elements such as key chains, composite keywords and special annotations.
Keyword extraction
Classifier computes the keywords of a fulltext document based on the frequency of thesaurus terms in it. In other words, it calculates how many times a thesaurus keyword (and its alternative and hidden labels, defined in the taxonomy) appears in a text and it ranks the results. Unlike other similar systems, Classifier does not use any machine learning or AI methodologies - a just plain phrase matching using regular expressions: it exploits the conformation and richness of the thesaurus to produce accurate results. It is then clear that Classifier performs best on top of rich, well-structured, subject thesauri expressed in the RDF/SKOS language.
Running tests
Use the provided Dockerfile to run the tests with all dependencies installed. From the repository root, build the image and run the suite:
docker build -t invenio-classifier-tests .
docker run --rm invenio-classifier-tests poetry run pytest
The test run also prints a coverage report, including missing lines.
Happy hacking and thanks for flying Invenio-Classifier.
Inspirehep Development Team Email: admin@inspirehep.net Twitter: http://twitter.com/inveniosoftware GitHub: https://github.com/inveniosoftware-contrib/invenio-classifier URL: http://inveniosoftware.org
Metadata
Release files for invenio-classifier 1.3.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| invenio_classifier-1.3.14.tar.gz | 55.9 kB | Without provenance | Details for invenio_classifier-1.3.14.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| invenio_classifier-1.3.14-py3-none-any.whl | Python 3 | none | any | Details for invenio_classifier-1.3.14-py3-none-any.whl |
Total release size: 120.3 kB
Release files / invenio_classifier-1.3.14.tar.gz
| Download URL | invenio_classifier-1.3.14.tar.gz |
|---|---|
| Size | 55.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2796c7c91d875795691a153c71f07e931a2588b8c024d21880a923a85233b701
|
|
BLAKE2b-256 checksum How to use checksums |
64481637ecdb1e70193d54b861379beb7a8d9b4dca3bf91ba8eb08489290ac6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / invenio_classifier-1.3.14-py3-none-any.whl
| Download URL | invenio_classifier-1.3.14-py3-none-any.whl |
|---|---|
| Size | 64.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb5a65300d2a2e29e6960ef39a82391e18ae8cd5d75772e4ca9baaff59a0d86b
|
|
BLAKE2b-256 checksum How to use checksums |
08918932641ea6abbbe7ac4a2705d5e805ab534815d7ea8947f73f4c4e826ba5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for invenio-classifier 1.3.14
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.