Compare commits
No commits in common. "master" and "252cbaeb9d27bc257e805587f19dca2fa95429c0" have entirely different histories.
master
...
252cbaeb9d
674
GPL-3.0
674
GPL-3.0
|
@ -1,674 +0,0 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
28
LICENSE
28
LICENSE
|
@ -1,13 +1,21 @@
|
||||||
Copyright (c) 2020-2022 Samuel L Sloniker
|
MIT License
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under
|
Copyright (c) 2020-2021 Samuel L Sloniker KJ7RRV
|
||||||
the terms of the GNU General Public License as published by the Free Software
|
|
||||||
Foundation, either version 3 of the License, or (at your option) any later
|
|
||||||
version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along with
|
The above copyright notice and this permission notice shall be included in all
|
||||||
this program. If not, see <https://www.gnu.org/licenses/>.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
164
README.md
164
README.md
|
@ -1,145 +1,44 @@
|
||||||
# GPTC
|
# GPTC
|
||||||
|
|
||||||
General-purpose text classifier in Python
|
General-purpose text classifier in Python
|
||||||
|
|
||||||
GPTC provides both a CLI tool and a Python library.
|
GPTC provides both a CLI tool and a Python library.
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
pip install gptc
|
|
||||||
|
|
||||||
## CLI Tool
|
## CLI Tool
|
||||||
|
|
||||||
### Classifying text
|
### Classifying text
|
||||||
|
|
||||||
gptc classify [-n <max_ngram_length>] <compiled model file>
|
`python -m gptc <modelfile>`
|
||||||
|
|
||||||
This will prompt for a string and classify it, then print (in JSON) a dict of
|
This will prompt for a string and classify it, outputting the category on
|
||||||
the format `{category: probability, category:probability, ...}` to stdout. (For
|
stdout (or "None" if it cannot determine anything).
|
||||||
information about `-n <max_ngram_length>`, see section "Ngrams.")
|
|
||||||
|
|
||||||
### Checking individual words or ngrams
|
Alternatively, if you need confidence data, use:
|
||||||
|
|
||||||
gptc check <compiled model file> <token or ngram>
|
`python -m gptc -j <modelfile>`
|
||||||
|
|
||||||
This is very similar to `gptc classify`, except it takes the input as an
|
This will print (in JSON) a dict of the format `{category: probability,
|
||||||
argument, and it treats the input as a single token or ngram.
|
category:probability, ...}` to stdout.
|
||||||
|
|
||||||
### Compiling models
|
### Compiling models
|
||||||
|
|
||||||
gptc compile [-n <max_ngram_length>] [-c <min_count>] <raw model file> <compiled model file>
|
gptc <raw model file> -c|--compile <compiled model file>
|
||||||
|
|
||||||
This will write the compiled model encoded in binary format to `<compiled model
|
|
||||||
file>`.
|
|
||||||
|
|
||||||
If `-c` is specified, words and ngrams used less than `min_count` times will be
|
|
||||||
excluded from the compiled model.
|
|
||||||
|
|
||||||
### Packing models
|
|
||||||
|
|
||||||
gptc pack <dir>
|
|
||||||
|
|
||||||
This will print the raw model in JSON to stdout. See `models/unpacked/` for an
|
|
||||||
example of the format. Any exceptions will be printed to stderr.
|
|
||||||
|
|
||||||
## Library
|
## Library
|
||||||
|
### `gptc.Classifier(model)`
|
||||||
### `Model.serialize(file)`
|
Create a `Classifier` object using the given *compiled* model (as a dict, not
|
||||||
|
JSON).
|
||||||
Write binary data representing the model to `file`.
|
#### `Classifier.confidence(text)`
|
||||||
|
|
||||||
### `Model.deserialize(encoded_model)`
|
|
||||||
|
|
||||||
Deserialize a `Model` from a file containing data from `Model.serialize()`.
|
|
||||||
|
|
||||||
### `Model.confidence(text, max_ngram_length)`
|
|
||||||
|
|
||||||
Classify `text`. Returns a dict of the format `{category: probability,
|
Classify `text`. Returns a dict of the format `{category: probability,
|
||||||
category:probability, ...}`
|
category:probability, ...}`
|
||||||
|
#### `Classifier.classify(text)`
|
||||||
Note that this may not include values for all categories. If there are no
|
Classify `text`. Returns the category into which the text is placed (as a
|
||||||
common words between the input and the training data (likely, for example, with
|
string), or `None` when it cannot classify the text.
|
||||||
input in a different language from the training data), an empty dict will be
|
## `gptc.compile(raw_model)`
|
||||||
returned.
|
|
||||||
|
|
||||||
For information about `max_ngram_length`, see section "Ngrams."
|
|
||||||
|
|
||||||
### `Model.get(token)`
|
|
||||||
|
|
||||||
Return a confidence dict for the given token or ngram. This function is very
|
|
||||||
similar to `Model.confidence()`, except it treats the input as a single token
|
|
||||||
or ngram.
|
|
||||||
|
|
||||||
### `Model.compile(raw_model, max_ngram_length=1, min_count=1, hash_algorithm="sha256")`
|
|
||||||
|
|
||||||
Compile a raw model (as a list, not JSON) and return the compiled model (as a
|
Compile a raw model (as a list, not JSON) and return the compiled model (as a
|
||||||
`gptc.Model` object).
|
dict).
|
||||||
|
|
||||||
For information about `max_ngram_length`, see section "Ngrams."
|
|
||||||
|
|
||||||
Words or ngrams used less than `min_count` times throughout the input text are
|
|
||||||
excluded from the model.
|
|
||||||
|
|
||||||
The hash algorithm should be left as the default, which may change with a minor
|
|
||||||
version update, but it can be changed by the application if needed. It is
|
|
||||||
stored in the model, so changing the algorithm does not affect compatibility.
|
|
||||||
The following algorithms are supported:
|
|
||||||
|
|
||||||
* `md5`
|
|
||||||
* `sha1`
|
|
||||||
* `sha224`
|
|
||||||
* `sha256`
|
|
||||||
* `sha384`
|
|
||||||
* `sha512`
|
|
||||||
* `sha3_224`
|
|
||||||
* `sha3_384`
|
|
||||||
* `sha3_256`
|
|
||||||
* `sha3_512`
|
|
||||||
* `shake_128`
|
|
||||||
* `shake_256`
|
|
||||||
* `blake2b`
|
|
||||||
* `blake2s`
|
|
||||||
|
|
||||||
### `gptc.pack(directory, print_exceptions=False)`
|
|
||||||
|
|
||||||
Pack the model in `directory` and return a tuple of the format:
|
|
||||||
|
|
||||||
(raw_model, [(exception,),(exception,)...])
|
|
||||||
|
|
||||||
Note that the exceptions are contained in single-item tuples. This is to allow
|
|
||||||
more information to be provided without breaking the API in future versions of
|
|
||||||
GPTC.
|
|
||||||
|
|
||||||
See `models/unpacked/` for an example of the format.
|
|
||||||
|
|
||||||
### `gptc.Classifier(model, max_ngram_length=1)`
|
|
||||||
|
|
||||||
`Classifier` objects are deprecated starting with GPTC 3.1.0, and will be
|
|
||||||
removed in 5.0.0. See [the README from
|
|
||||||
3.0.2](https://git.kj7rrv.com/kj7rrv/gptc/src/tag/v3.0.1/README.md) if you need
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
## Ngrams
|
|
||||||
|
|
||||||
GPTC optionally supports using ngrams to improve classification accuracy. They
|
|
||||||
are disabled by default (maximum length set to 1) for performance reasons.
|
|
||||||
Enabling them significantly increases the time required both for compilation
|
|
||||||
and classification. The effect seems more significant for compilation than for
|
|
||||||
classification. Compiled models are also much larger when ngrams are enabled.
|
|
||||||
Larger maximum ngram lengths will result in slower performance and larger
|
|
||||||
files. It is a good idea to experiment with different values and use the
|
|
||||||
highest one at which GPTC is fast enough and models are small enough for your
|
|
||||||
needs.
|
|
||||||
|
|
||||||
Once a model is compiled at a certain maximum ngram length, it cannot be used
|
|
||||||
for classification with a higher value. If you instantiate a `Classifier` with
|
|
||||||
a model compiled with a lower `max_ngram_length`, the value will be silently
|
|
||||||
reduced to the one used when compiling the model.
|
|
||||||
|
|
||||||
## Model format
|
## Model format
|
||||||
|
This section explains the raw model format, which is how you should create and
|
||||||
This section explains the raw model format, which is how models are created and
|
edit models.
|
||||||
edited.
|
|
||||||
|
|
||||||
Raw models are formatted as a list of dicts. See below for the format:
|
Raw models are formatted as a list of dicts. See below for the format:
|
||||||
|
|
||||||
|
@ -150,30 +49,13 @@ Raw models are formatted as a list of dicts. See below for the format:
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
GPTC handles raw models as `list`s of `dict`s of `str`s (`List[Dict[str,
|
GPTC handles models as Python `list`s of `dict`s of `str`s (for raw models) or
|
||||||
str]]`), and they can be stored in any way these Python objects can be.
|
`dict`s of `str`s and `float`s (for compiled models), and they can be stored
|
||||||
However, it is recommended to store them in JSON format for compatibility with
|
in any way these Python objects can be. However, it is recommended to store
|
||||||
the command-line tool.
|
them in JSON format for compatibility with the command-line tool.
|
||||||
|
|
||||||
## Emoji
|
|
||||||
|
|
||||||
GPTC treats individual emoji as words.
|
|
||||||
|
|
||||||
## Example model
|
## Example model
|
||||||
|
|
||||||
An example model, which is designed to distinguish between texts written by
|
An example model, which is designed to distinguish between texts written by
|
||||||
Mark Twain and those written by William Shakespeare, is available in `models`.
|
Mark Twain and those written by William Shakespeare, is available in `models`.
|
||||||
The raw model is in `models/raw.json`; the compiled model is in
|
The raw model is in `models/raw.json`; the compiled model is in
|
||||||
`models/compiled.json`.
|
`models/compiled.json`.
|
||||||
|
|
||||||
The example model was compiled with `max_ngram_length=10`.
|
|
||||||
|
|
||||||
## Benchmark
|
|
||||||
|
|
||||||
A benchmark script is available for comparing performance of GPTC between
|
|
||||||
different Python versions. To use it, run `benchmark.py` with all of the Python
|
|
||||||
installations you want to test. It tests both compilation and classification.
|
|
||||||
It uses the default Twain/Shakespeare model for both, and for classification it
|
|
||||||
uses [Mark Antony's "Friends, Romans, countrymen"
|
|
||||||
speech](https://en.wikipedia.org/wiki/Friends,_Romans,_countrymen,_lend_me_your_ears)
|
|
||||||
from Shakespeare's *Julius Caesar*.
|
|
||||||
|
|
56
benchmark.py
56
benchmark.py
|
@ -1,56 +0,0 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
import timeit
|
|
||||||
import gptc
|
|
||||||
import json
|
|
||||||
import sys
|
|
||||||
|
|
||||||
max_ngram_length = 10
|
|
||||||
compile_iterations = 100
|
|
||||||
classify_iterations = 10000
|
|
||||||
|
|
||||||
with open("models/raw.json") as f:
|
|
||||||
raw_model = json.load(f)
|
|
||||||
|
|
||||||
with open("models/benchmark_text.txt") as f:
|
|
||||||
text = f.read()
|
|
||||||
|
|
||||||
print("Benchmarking GPTC on Python", sys.version)
|
|
||||||
print("Maximum ngram length:", max_ngram_length)
|
|
||||||
|
|
||||||
print(
|
|
||||||
"Average compilation time over",
|
|
||||||
compile_iterations,
|
|
||||||
"iterations:",
|
|
||||||
round(
|
|
||||||
1000000
|
|
||||||
* timeit.timeit(
|
|
||||||
"gptc.Model.compile(raw_model, max_ngram_length)",
|
|
||||||
number=compile_iterations,
|
|
||||||
globals=globals(),
|
|
||||||
)
|
|
||||||
/ compile_iterations
|
|
||||||
),
|
|
||||||
"microseconds",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
classifier = gptc.Classifier(
|
|
||||||
gptc.compile(raw_model, max_ngram_length), max_ngram_length
|
|
||||||
)
|
|
||||||
print(
|
|
||||||
"Average classification time over",
|
|
||||||
classify_iterations,
|
|
||||||
"iterations:",
|
|
||||||
round(
|
|
||||||
1000000
|
|
||||||
* timeit.timeit(
|
|
||||||
"classifier.classify(text)",
|
|
||||||
number=classify_iterations,
|
|
||||||
globals=globals(),
|
|
||||||
)
|
|
||||||
/ classify_iterations
|
|
||||||
),
|
|
||||||
"microseconds",
|
|
||||||
)
|
|
||||||
print("--- benchmark complete ---")
|
|
|
@ -1,12 +1,5 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
"""General-Purpose Text Classifier"""
|
"""General-Purpose Text Classifier"""
|
||||||
|
|
||||||
from gptc.pack import pack
|
from gptc.compiler import compile
|
||||||
from gptc.model import Model
|
from gptc.classifier import Classifier
|
||||||
from gptc.tokenizer import normalize
|
from gptc.exceptions import *
|
||||||
from gptc.exceptions import (
|
|
||||||
GPTCError,
|
|
||||||
ModelError,
|
|
||||||
InvalidModelError,
|
|
||||||
)
|
|
||||||
|
|
|
@ -1,88 +1,27 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import json
|
import json
|
||||||
import sys
|
import sys
|
||||||
import gptc
|
import gptc
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(description="General Purpose Text Classifier")
|
||||||
def main() -> None:
|
parser.add_argument('model', help='model to use')
|
||||||
parser = argparse.ArgumentParser(
|
parser.add_argument('-c', '--compile', help='compile raw model model to outfile', metavar='outfile')
|
||||||
description="General Purpose Text Classifier", prog="gptc"
|
parser.add_argument('-j', '--confidence', help='output confidence dict in json', action='store_true')
|
||||||
)
|
|
||||||
subparsers = parser.add_subparsers(dest="subparser_name", required=True)
|
|
||||||
|
|
||||||
compile_parser = subparsers.add_parser(
|
|
||||||
"compile", help="compile a raw model"
|
|
||||||
)
|
|
||||||
compile_parser.add_argument("model", help="raw model to compile")
|
|
||||||
compile_parser.add_argument(
|
|
||||||
"out", help="name of file to write compiled model to"
|
|
||||||
)
|
|
||||||
compile_parser.add_argument(
|
|
||||||
"--max-ngram-length",
|
|
||||||
"-n",
|
|
||||||
help="maximum ngram length",
|
|
||||||
type=int,
|
|
||||||
default=1,
|
|
||||||
)
|
|
||||||
compile_parser.add_argument(
|
|
||||||
"--min-count",
|
|
||||||
"-c",
|
|
||||||
help="minimum use count for word/ngram to be included in model",
|
|
||||||
type=int,
|
|
||||||
default=1,
|
|
||||||
)
|
|
||||||
|
|
||||||
classify_parser = subparsers.add_parser("classify", help="classify text")
|
|
||||||
classify_parser.add_argument("model", help="compiled model to use")
|
|
||||||
classify_parser.add_argument(
|
|
||||||
"--max-ngram-length",
|
|
||||||
"-n",
|
|
||||||
help="maximum ngram length",
|
|
||||||
type=int,
|
|
||||||
default=1,
|
|
||||||
)
|
|
||||||
|
|
||||||
check_parser = subparsers.add_parser(
|
|
||||||
"check", help="check one word or ngram in model"
|
|
||||||
)
|
|
||||||
check_parser.add_argument("model", help="compiled model to use")
|
|
||||||
check_parser.add_argument("token", help="token or ngram to check")
|
|
||||||
|
|
||||||
pack_parser = subparsers.add_parser(
|
|
||||||
"pack", help="pack a model from a directory"
|
|
||||||
)
|
|
||||||
pack_parser.add_argument("model", help="directory containing model")
|
|
||||||
|
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
if args.subparser_name == "compile":
|
with open(args.model, 'r') as f:
|
||||||
with open(args.model, "r", encoding="utf-8") as input_file:
|
raw_model = json.load(f)
|
||||||
model = json.load(input_file)
|
if args.compile:
|
||||||
|
with open(args.compile, 'w+') as f:
|
||||||
with open(args.out, "wb+") as output_file:
|
json.dump(gptc.compile(raw_model), f)
|
||||||
gptc.Model.compile(
|
else:
|
||||||
model, args.max_ngram_length, args.min_count
|
classifier = gptc.Classifier(raw_model)
|
||||||
).serialize(output_file)
|
|
||||||
elif args.subparser_name == "classify":
|
|
||||||
with open(args.model, "rb") as model_file:
|
|
||||||
model = gptc.Model.deserialize(model_file)
|
|
||||||
|
|
||||||
if sys.stdin.isatty():
|
if sys.stdin.isatty():
|
||||||
text = input("Text to analyse: ")
|
text = input('Text to analyse: ')
|
||||||
else:
|
else:
|
||||||
text = sys.stdin.read()
|
text = sys.stdin.read()
|
||||||
|
if args.confidence:
|
||||||
print(json.dumps(model.confidence(text, args.max_ngram_length)))
|
print(json.dumps(classifier.confidence(text)))
|
||||||
elif args.subparser_name == "check":
|
|
||||||
with open(args.model, "rb") as model_file:
|
|
||||||
model = gptc.Model.deserialize(model_file)
|
|
||||||
print(json.dumps(model.get(args.token)))
|
|
||||||
else:
|
else:
|
||||||
print(json.dumps(gptc.pack(args.model, True)[0]))
|
print(classifier.classify(text))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
|
|
90
gptc/classifier.py
Executable file
90
gptc/classifier.py
Executable file
|
@ -0,0 +1,90 @@
|
||||||
|
import gptc.tokenizer, gptc.compiler, gptc.exceptions
|
||||||
|
import warnings
|
||||||
|
|
||||||
|
class Classifier:
|
||||||
|
"""A text classifier.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
model : dict
|
||||||
|
A compiled GPTC model.
|
||||||
|
|
||||||
|
Attributes
|
||||||
|
----------
|
||||||
|
model : dict
|
||||||
|
The model used.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, model):
|
||||||
|
try:
|
||||||
|
model_version = model['__version__']
|
||||||
|
except:
|
||||||
|
model_version = 1
|
||||||
|
|
||||||
|
if model_version == 3:
|
||||||
|
self.model = model
|
||||||
|
else:
|
||||||
|
# The model is an unsupported version
|
||||||
|
try:
|
||||||
|
raw_model = model['__raw__']
|
||||||
|
except:
|
||||||
|
raise gptc.exceptions.UnsupportedModelError('this model is unsupported and does not contain a raw model for recompiling')
|
||||||
|
|
||||||
|
warnings.warn("model needed to be recompiled on-the-fly; please re-compile it and use the new compiled model in the future")
|
||||||
|
self.model = gptc.compiler.compile(raw_model)
|
||||||
|
|
||||||
|
def confidence(self, text):
|
||||||
|
"""Classify text with confidence.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
text : str
|
||||||
|
The text to classify
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
dict
|
||||||
|
{category:probability, category:probability...} or {} if no words
|
||||||
|
matching any categories in the model were found
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
model = self.model
|
||||||
|
|
||||||
|
text = gptc.tokenizer.tokenize(text)
|
||||||
|
probs = {}
|
||||||
|
for word in text:
|
||||||
|
try:
|
||||||
|
for category, value in enumerate(model[word]):
|
||||||
|
try:
|
||||||
|
probs[category] += value
|
||||||
|
except KeyError:
|
||||||
|
probs[category] = value
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
probs = {model['__names__'][category]: value/65535 for category, value in probs.items()}
|
||||||
|
total = sum(probs.values())
|
||||||
|
probs = {category: value/total for category, value in probs.items()}
|
||||||
|
return probs
|
||||||
|
|
||||||
|
def classify(self, text):
|
||||||
|
"""Classify text.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
text : str
|
||||||
|
The text to classify
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
str or None
|
||||||
|
The most likely category, or None if no words matching any
|
||||||
|
category in the model were found.
|
||||||
|
|
||||||
|
"""
|
||||||
|
probs = self.confidence(text)
|
||||||
|
try:
|
||||||
|
return sorted(probs.items(), key=lambda x: x[1])[-1][0]
|
||||||
|
except IndexError:
|
||||||
|
return None
|
62
gptc/compiler.py
Executable file
62
gptc/compiler.py
Executable file
|
@ -0,0 +1,62 @@
|
||||||
|
import gptc.tokenizer
|
||||||
|
|
||||||
|
def compile(raw_model):
|
||||||
|
"""Compile a raw model.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
raw_model : list of dict
|
||||||
|
A raw GPTC model.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
dict
|
||||||
|
A compiled GPTC model.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
categories = {}
|
||||||
|
|
||||||
|
for portion in raw_model:
|
||||||
|
text = gptc.tokenizer.tokenize(portion['text'])
|
||||||
|
category = portion['category']
|
||||||
|
try:
|
||||||
|
categories[category] += text
|
||||||
|
except KeyError:
|
||||||
|
categories[category] = text
|
||||||
|
|
||||||
|
categories_by_count = {}
|
||||||
|
|
||||||
|
names = []
|
||||||
|
|
||||||
|
for category, text in categories.items():
|
||||||
|
if not category in names:
|
||||||
|
names.append(category)
|
||||||
|
|
||||||
|
categories_by_count[category] = {}
|
||||||
|
for word in text:
|
||||||
|
try:
|
||||||
|
categories_by_count[category][word] += 1/len(categories[category])
|
||||||
|
except KeyError:
|
||||||
|
categories_by_count[category][word] = 1/len(categories[category])
|
||||||
|
word_weights = {}
|
||||||
|
for category, words in categories_by_count.items():
|
||||||
|
for word, value in words.items():
|
||||||
|
try:
|
||||||
|
word_weights[word][category] = value
|
||||||
|
except KeyError:
|
||||||
|
word_weights[word] = {category:value}
|
||||||
|
|
||||||
|
model = {}
|
||||||
|
for word, weights in word_weights.items():
|
||||||
|
total = sum(weights.values())
|
||||||
|
model[word] = []
|
||||||
|
for category in names:
|
||||||
|
model[word].append(round((weights.get(category, 0)/total)*65535))
|
||||||
|
|
||||||
|
model['__names__'] = names
|
||||||
|
|
||||||
|
model['__version__'] = 3
|
||||||
|
model['__raw__'] = raw_model
|
||||||
|
|
||||||
|
return model
|
|
@ -1,13 +1,8 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
|
|
||||||
class GPTCError(BaseException):
|
class GPTCError(BaseException):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class ModelError(GPTCError):
|
class ModelError(GPTCError):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
class UnsupportedModelError(ModelError):
|
||||||
class InvalidModelError(ModelError):
|
|
||||||
pass
|
pass
|
||||||
|
|
322
gptc/model.py
322
gptc/model.py
|
@ -1,322 +0,0 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
from typing import (
|
|
||||||
Iterable,
|
|
||||||
Mapping,
|
|
||||||
List,
|
|
||||||
Dict,
|
|
||||||
cast,
|
|
||||||
BinaryIO,
|
|
||||||
Tuple,
|
|
||||||
TypedDict,
|
|
||||||
)
|
|
||||||
import json
|
|
||||||
import gptc.tokenizer
|
|
||||||
from gptc.exceptions import InvalidModelError
|
|
||||||
import gptc.weighting
|
|
||||||
|
|
||||||
def _count_words(
|
|
||||||
raw_model: Iterable[Mapping[str, str]],
|
|
||||||
max_ngram_length: int,
|
|
||||||
hash_algorithm: str,
|
|
||||||
) -> Tuple[Dict[int, Dict[str, int]], Dict[str, int], List[str]]:
|
|
||||||
word_counts: Dict[int, Dict[str, int]] = {}
|
|
||||||
category_lengths: Dict[str, int] = {}
|
|
||||||
names: List[str] = []
|
|
||||||
|
|
||||||
for portion in raw_model:
|
|
||||||
text = gptc.tokenizer.hash_list(
|
|
||||||
gptc.tokenizer.tokenize(portion["text"], max_ngram_length),
|
|
||||||
hash_algorithm,
|
|
||||||
)
|
|
||||||
category = portion["category"]
|
|
||||||
|
|
||||||
if not category in names:
|
|
||||||
names.append(category)
|
|
||||||
|
|
||||||
category_lengths[category] = category_lengths.get(category, 0) + len(
|
|
||||||
text
|
|
||||||
)
|
|
||||||
|
|
||||||
for word in text:
|
|
||||||
if word in word_counts:
|
|
||||||
try:
|
|
||||||
word_counts[word][category] += 1
|
|
||||||
except KeyError:
|
|
||||||
word_counts[word][category] = 1
|
|
||||||
else:
|
|
||||||
word_counts[word] = {category: 1}
|
|
||||||
|
|
||||||
return word_counts, category_lengths, names
|
|
||||||
|
|
||||||
|
|
||||||
def _get_weights(
|
|
||||||
min_count: int,
|
|
||||||
word_counts: Dict[int, Dict[str, int]],
|
|
||||||
category_lengths: Dict[str, int],
|
|
||||||
names: List[str],
|
|
||||||
) -> Dict[int, List[int]]:
|
|
||||||
model: Dict[int, List[int]] = {}
|
|
||||||
for word, counts in word_counts.items():
|
|
||||||
if sum(counts.values()) >= min_count:
|
|
||||||
weights = {
|
|
||||||
category: value / category_lengths[category]
|
|
||||||
for category, value in counts.items()
|
|
||||||
}
|
|
||||||
total = sum(weights.values())
|
|
||||||
new_weights: List[int] = []
|
|
||||||
for category in names:
|
|
||||||
new_weights.append(
|
|
||||||
round((weights.get(category, 0) / total) * 65535)
|
|
||||||
)
|
|
||||||
model[word] = new_weights
|
|
||||||
return model
|
|
||||||
|
|
||||||
class ExplanationEntry(TypedDict):
|
|
||||||
weight: float
|
|
||||||
probabilities: Dict[str, float]
|
|
||||||
count: int
|
|
||||||
|
|
||||||
|
|
||||||
Explanation = Dict[
|
|
||||||
str,
|
|
||||||
ExplanationEntry,
|
|
||||||
]
|
|
||||||
|
|
||||||
Log = List[Tuple[str, float, List[float]]]
|
|
||||||
|
|
||||||
|
|
||||||
class Confidences(dict[str, float]):
|
|
||||||
def __init__(self, probs: Dict[str, float]):
|
|
||||||
dict.__init__(self, probs)
|
|
||||||
|
|
||||||
|
|
||||||
class TransparentConfidences(Confidences):
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
probs: Dict[str, float],
|
|
||||||
explanation: Explanation,
|
|
||||||
):
|
|
||||||
self.explanation = explanation
|
|
||||||
Confidences.__init__(self, probs)
|
|
||||||
|
|
||||||
|
|
||||||
def convert_log(log: Log, names: List[str]) -> Explanation:
|
|
||||||
explanation: Explanation = {}
|
|
||||||
for word2, weight, word_probs in log:
|
|
||||||
if word2 in explanation:
|
|
||||||
explanation[word2]["count"] += 1
|
|
||||||
else:
|
|
||||||
explanation[word2] = {
|
|
||||||
"weight": weight,
|
|
||||||
"probabilities": {
|
|
||||||
name: word_probs[index] for index, name in enumerate(names)
|
|
||||||
},
|
|
||||||
"count": 1,
|
|
||||||
}
|
|
||||||
return explanation
|
|
||||||
|
|
||||||
|
|
||||||
class Model:
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
weights: Dict[int, List[int]],
|
|
||||||
names: List[str],
|
|
||||||
max_ngram_length: int,
|
|
||||||
hash_algorithm: str,
|
|
||||||
):
|
|
||||||
self.weights = weights
|
|
||||||
self.names = names
|
|
||||||
self.max_ngram_length = max_ngram_length
|
|
||||||
self.hash_algorithm = hash_algorithm
|
|
||||||
|
|
||||||
def confidence(
|
|
||||||
self, text: str, max_ngram_length: int, transparent: bool = False
|
|
||||||
) -> Confidences:
|
|
||||||
"""Classify text with confidence.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
text : str
|
|
||||||
The text to classify
|
|
||||||
|
|
||||||
max_ngram_length : int
|
|
||||||
The maximum ngram length to use in classifying
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
dict
|
|
||||||
{category:probability, category:probability...} or {} if no words
|
|
||||||
matching any categories in the model were found
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
model = self.weights
|
|
||||||
max_ngram_length = min(self.max_ngram_length, max_ngram_length)
|
|
||||||
|
|
||||||
raw_tokens = gptc.tokenizer.tokenize(
|
|
||||||
text, min(max_ngram_length, self.max_ngram_length)
|
|
||||||
)
|
|
||||||
|
|
||||||
tokens = gptc.tokenizer.hash_list(
|
|
||||||
raw_tokens,
|
|
||||||
self.hash_algorithm,
|
|
||||||
)
|
|
||||||
|
|
||||||
if transparent:
|
|
||||||
token_map = {tokens[i]: raw_tokens[i] for i in range(len(tokens))}
|
|
||||||
log: Log = []
|
|
||||||
|
|
||||||
numbered_probs: Dict[int, float] = {}
|
|
||||||
|
|
||||||
for word in tokens:
|
|
||||||
try:
|
|
||||||
unweighted_numbers = [
|
|
||||||
i / 65535 for i in cast(List[float], model[word])
|
|
||||||
]
|
|
||||||
|
|
||||||
weight, weighted_numbers = gptc.weighting.weight(
|
|
||||||
unweighted_numbers
|
|
||||||
)
|
|
||||||
|
|
||||||
if transparent:
|
|
||||||
log.append(
|
|
||||||
(
|
|
||||||
token_map[word],
|
|
||||||
weight,
|
|
||||||
unweighted_numbers,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
for category, value in enumerate(weighted_numbers):
|
|
||||||
try:
|
|
||||||
numbered_probs[category] += value
|
|
||||||
except KeyError:
|
|
||||||
numbered_probs[category] = value
|
|
||||||
except KeyError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
total = sum(numbered_probs.values())
|
|
||||||
probs: Dict[str, float] = {
|
|
||||||
self.names[category]: value / total
|
|
||||||
for category, value in numbered_probs.items()
|
|
||||||
}
|
|
||||||
|
|
||||||
if transparent:
|
|
||||||
explanation = convert_log(log, self.names)
|
|
||||||
return TransparentConfidences(probs, explanation)
|
|
||||||
|
|
||||||
return Confidences(probs)
|
|
||||||
|
|
||||||
def get(self, token: str) -> Dict[str, float]:
|
|
||||||
try:
|
|
||||||
weights = self.weights[
|
|
||||||
gptc.tokenizer.hash_single(
|
|
||||||
gptc.tokenizer.normalize(token), self.hash_algorithm
|
|
||||||
)
|
|
||||||
]
|
|
||||||
except KeyError:
|
|
||||||
return {}
|
|
||||||
return {
|
|
||||||
category: weights[index] / 65535
|
|
||||||
for index, category in enumerate(self.names)
|
|
||||||
}
|
|
||||||
|
|
||||||
def serialize(self, file: BinaryIO) -> None:
|
|
||||||
file.write(b"GPTC model v6\n")
|
|
||||||
file.write(
|
|
||||||
json.dumps(
|
|
||||||
{
|
|
||||||
"names": self.names,
|
|
||||||
"max_ngram_length": self.max_ngram_length,
|
|
||||||
"hash_algorithm": self.hash_algorithm,
|
|
||||||
}
|
|
||||||
).encode("utf-8")
|
|
||||||
+ b"\n"
|
|
||||||
)
|
|
||||||
for word, weights in self.weights.items():
|
|
||||||
file.write(
|
|
||||||
word.to_bytes(6, "big")
|
|
||||||
+ b"".join([weight.to_bytes(2, "big") for weight in weights])
|
|
||||||
)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def compile(
|
|
||||||
raw_model: Iterable[Mapping[str, str]],
|
|
||||||
max_ngram_length: int = 1,
|
|
||||||
min_count: int = 1,
|
|
||||||
hash_algorithm: str = "sha256",
|
|
||||||
) -> 'Model':
|
|
||||||
"""Compile a raw model.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
raw_model : list of dict
|
|
||||||
A raw GPTC model.
|
|
||||||
|
|
||||||
max_ngram_length : int
|
|
||||||
Maximum ngram lenght to compile with.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
dict
|
|
||||||
A compiled GPTC model.
|
|
||||||
|
|
||||||
"""
|
|
||||||
word_counts, category_lengths, names = _count_words(
|
|
||||||
raw_model, max_ngram_length, hash_algorithm
|
|
||||||
)
|
|
||||||
model = _get_weights(min_count, word_counts, category_lengths, names)
|
|
||||||
return Model(model, names, max_ngram_length, hash_algorithm)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def deserialize(encoded_model: BinaryIO) -> "Model":
|
|
||||||
prefix = encoded_model.read(14)
|
|
||||||
if prefix != b"GPTC model v6\n":
|
|
||||||
raise InvalidModelError()
|
|
||||||
|
|
||||||
config_json = b""
|
|
||||||
while True:
|
|
||||||
byte = encoded_model.read(1)
|
|
||||||
if byte == b"\n":
|
|
||||||
break
|
|
||||||
|
|
||||||
if byte == b"":
|
|
||||||
raise InvalidModelError()
|
|
||||||
|
|
||||||
config_json += byte
|
|
||||||
|
|
||||||
try:
|
|
||||||
config = json.loads(config_json.decode("utf-8"))
|
|
||||||
except (UnicodeDecodeError, json.JSONDecodeError) as exc:
|
|
||||||
raise InvalidModelError() from exc
|
|
||||||
|
|
||||||
try:
|
|
||||||
names = config["names"]
|
|
||||||
max_ngram_length = config["max_ngram_length"]
|
|
||||||
hash_algorithm = config["hash_algorithm"]
|
|
||||||
except KeyError as exc:
|
|
||||||
raise InvalidModelError() from exc
|
|
||||||
|
|
||||||
if not (
|
|
||||||
isinstance(names, list) and isinstance(max_ngram_length, int)
|
|
||||||
) or not all(isinstance(name, str) for name in names):
|
|
||||||
raise InvalidModelError()
|
|
||||||
|
|
||||||
weight_code_length = 6 + 2 * len(names)
|
|
||||||
|
|
||||||
weights: Dict[int, List[int]] = {}
|
|
||||||
|
|
||||||
while True:
|
|
||||||
code = encoded_model.read(weight_code_length)
|
|
||||||
if not code:
|
|
||||||
break
|
|
||||||
if len(code) != weight_code_length:
|
|
||||||
raise InvalidModelError()
|
|
||||||
|
|
||||||
weights[int.from_bytes(code[:6], "big")] = [
|
|
||||||
int.from_bytes(value, "big")
|
|
||||||
for value in [code[x : x + 2] for x in range(6, len(code), 2)]
|
|
||||||
]
|
|
||||||
|
|
||||||
return Model(weights, names, max_ngram_length, hash_algorithm)
|
|
38
gptc/pack.py
38
gptc/pack.py
|
@ -1,38 +0,0 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
import sys
|
|
||||||
import os
|
|
||||||
from typing import List, Dict, Tuple
|
|
||||||
|
|
||||||
|
|
||||||
def pack(
|
|
||||||
directory: str, print_exceptions: bool = False
|
|
||||||
) -> Tuple[List[Dict[str, str]], List[Tuple[OSError]]]:
|
|
||||||
paths = os.listdir(directory)
|
|
||||||
texts: Dict[str, List[str]] = {}
|
|
||||||
exceptions = []
|
|
||||||
|
|
||||||
for path in paths:
|
|
||||||
texts[path] = []
|
|
||||||
try:
|
|
||||||
for file in os.listdir(os.path.join(directory, path)):
|
|
||||||
try:
|
|
||||||
with open(
|
|
||||||
os.path.join(directory, path, file), encoding="utf-8"
|
|
||||||
) as input_file:
|
|
||||||
texts[path].append(input_file.read())
|
|
||||||
except OSError as error:
|
|
||||||
exceptions.append((error,))
|
|
||||||
if print_exceptions:
|
|
||||||
print(error, file=sys.stderr)
|
|
||||||
except OSError as error:
|
|
||||||
exceptions.append((error,))
|
|
||||||
if print_exceptions:
|
|
||||||
print(error, file=sys.stderr)
|
|
||||||
|
|
||||||
raw_model = []
|
|
||||||
|
|
||||||
for category, cat_texts in texts.items():
|
|
||||||
raw_model += [{"category": category, "text": i} for i in cat_texts]
|
|
||||||
|
|
||||||
return raw_model, exceptions
|
|
|
@ -1,86 +1,11 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
def tokenize(text):
|
||||||
|
"""Convert a string to a list of lemmas."""
|
||||||
|
out = [""]
|
||||||
|
|
||||||
import unicodedata
|
for char in text.lower():
|
||||||
from typing import List, cast
|
if char.isalpha() or char == "'":
|
||||||
import hashlib
|
out[-1] += char
|
||||||
import emoji
|
elif out[-1] != "":
|
||||||
|
out.append("")
|
||||||
|
|
||||||
|
return [string for string in out if string]
|
||||||
def tokenize(text: str, max_ngram_length: int = 1) -> List[str]:
|
|
||||||
text = unicodedata.normalize("NFKD", text).casefold()
|
|
||||||
parts = []
|
|
||||||
highest_end = 0
|
|
||||||
for emoji_part in emoji.emoji_list(text):
|
|
||||||
parts += list(text[highest_end : emoji_part["match_start"]])
|
|
||||||
parts.append(emoji_part["emoji"])
|
|
||||||
highest_end = emoji_part["match_end"]
|
|
||||||
parts += list(text[highest_end:])
|
|
||||||
converted_text = [part for part in parts if part]
|
|
||||||
|
|
||||||
tokens = [""]
|
|
||||||
|
|
||||||
for char in converted_text:
|
|
||||||
if (
|
|
||||||
char.isalpha()
|
|
||||||
or char.isnumeric()
|
|
||||||
or char == "'"
|
|
||||||
or (char in ",." and (" " + tokens[-1])[-1].isnumeric())
|
|
||||||
):
|
|
||||||
tokens[-1] += char
|
|
||||||
elif emoji.is_emoji(char):
|
|
||||||
tokens.append(char)
|
|
||||||
tokens.append("")
|
|
||||||
elif tokens[-1] != "":
|
|
||||||
tokens.append("")
|
|
||||||
|
|
||||||
tokens = [string for string in tokens if string]
|
|
||||||
|
|
||||||
if max_ngram_length == 1:
|
|
||||||
return tokens
|
|
||||||
|
|
||||||
ngrams = []
|
|
||||||
for ngram_length in range(1, max_ngram_length + 1):
|
|
||||||
for index in range(len(tokens) + 1 - ngram_length):
|
|
||||||
ngrams.append(" ".join(tokens[index : index + ngram_length]))
|
|
||||||
return ngrams
|
|
||||||
|
|
||||||
|
|
||||||
def _hash_single(token: str, hash_function: type) -> int:
|
|
||||||
return int.from_bytes(
|
|
||||||
hash_function(token.encode("utf-8")).digest()[:6], "big"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _get_hash_function(hash_algorithm: str) -> type:
|
|
||||||
if hash_algorithm in {
|
|
||||||
"sha224",
|
|
||||||
"md5",
|
|
||||||
"sha512",
|
|
||||||
"sha3_256",
|
|
||||||
"blake2s",
|
|
||||||
"sha3_224",
|
|
||||||
"sha1",
|
|
||||||
"sha256",
|
|
||||||
"sha384",
|
|
||||||
"shake_256",
|
|
||||||
"blake2b",
|
|
||||||
"sha3_512",
|
|
||||||
"shake_128",
|
|
||||||
"sha3_384",
|
|
||||||
}:
|
|
||||||
return cast(type, getattr(hashlib, hash_algorithm))
|
|
||||||
|
|
||||||
raise ValueError("not a valid hash function: " + hash_algorithm)
|
|
||||||
|
|
||||||
|
|
||||||
def hash_single(token: str, hash_algorithm: str) -> int:
|
|
||||||
return _hash_single(token, _get_hash_function(hash_algorithm))
|
|
||||||
|
|
||||||
|
|
||||||
def hash_list(tokens: List[str], hash_algorithm: str) -> List[int]:
|
|
||||||
hash_function = _get_hash_function(hash_algorithm)
|
|
||||||
return [_hash_single(token, hash_function) for token in tokens]
|
|
||||||
|
|
||||||
|
|
||||||
def normalize(text: str) -> str:
|
|
||||||
return " ".join(tokenize(text, 1))
|
|
||||||
|
|
|
@ -1,46 +0,0 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
import math
|
|
||||||
from typing import Sequence, Tuple, List
|
|
||||||
|
|
||||||
|
|
||||||
def _mean(numbers: Sequence[float]) -> float:
|
|
||||||
"""Calculate the mean of a group of numbers
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
numbers : list of int or float
|
|
||||||
The numbers to calculate the mean of
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
float
|
|
||||||
The mean of the numbers
|
|
||||||
"""
|
|
||||||
return sum(numbers) / len(numbers)
|
|
||||||
|
|
||||||
|
|
||||||
def _standard_deviation(numbers: Sequence[float]) -> float:
|
|
||||||
"""Calculate the standard deviation of a group of numbers
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
numbers : list of int or float
|
|
||||||
The numbers to calculate the mean of
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
float
|
|
||||||
The standard deviation of the numbers
|
|
||||||
|
|
||||||
"""
|
|
||||||
mean = _mean(numbers)
|
|
||||||
squared_deviations = [(mean - i) ** 2 for i in numbers]
|
|
||||||
return math.sqrt(_mean(squared_deviations))
|
|
||||||
|
|
||||||
|
|
||||||
def weight(numbers: Sequence[float]) -> Tuple[float, List[float]]:
|
|
||||||
standard_deviation = _standard_deviation(numbers)
|
|
||||||
weight_assigned = standard_deviation * 2
|
|
||||||
weighted_numbers = [i * weight_assigned for i in numbers]
|
|
||||||
return weight_assigned, weighted_numbers
|
|
|
@ -1,35 +0,0 @@
|
||||||
Friends, Romans, countrymen, lend me your ears;
|
|
||||||
I come to bury Caesar, not to praise him.
|
|
||||||
The evil that men do lives after them;
|
|
||||||
The good is oft interred with their bones;
|
|
||||||
So let it be with Caesar. The noble Brutus
|
|
||||||
Hath told you Caesar was ambitious:
|
|
||||||
If it were so, it was a grievous fault,
|
|
||||||
And grievously hath Caesar answer'd it.
|
|
||||||
Here, under leave of Brutus and the rest-
|
|
||||||
For Brutus is an honourable man;
|
|
||||||
So are they all, all honourable men-
|
|
||||||
Come I to speak in Caesar's funeral.
|
|
||||||
He was my friend, faithful and just to me:
|
|
||||||
But Brutus says he was ambitious;
|
|
||||||
And Brutus is an honourable man.
|
|
||||||
He hath brought many captives home to Rome
|
|
||||||
Whose ransoms did the general coffers fill:
|
|
||||||
Did this in Caesar seem ambitious?
|
|
||||||
When that the poor have cried, Caesar hath wept:
|
|
||||||
Ambition should be made of sterner stuff:
|
|
||||||
Yet Brutus says he was ambitious;
|
|
||||||
And Brutus is an honourable man.
|
|
||||||
You all did see that on the Lupercal
|
|
||||||
I thrice presented him a kingly crown,
|
|
||||||
Which he did thrice refuse: was this ambition?
|
|
||||||
Yet Brutus says he was ambitious;
|
|
||||||
And, sure, he is an honourable man.
|
|
||||||
I speak not to disprove what Brutus spoke,
|
|
||||||
But here I am to speak what I do know.
|
|
||||||
You all did love him once, not without cause:
|
|
||||||
What cause withholds you then, to mourn for him?
|
|
||||||
O judgment! thou art fled to brutish beasts,
|
|
||||||
And men have lost their reason. Bear with me;
|
|
||||||
My heart is in the coffin there with Caesar,
|
|
||||||
And I must pause till it come back to me.
|
|
Binary file not shown.
1
models/compiled.json
Normal file
1
models/compiled.json
Normal file
File diff suppressed because one or more lines are too long
16
profiler.py
16
profiler.py
|
@ -1,16 +0,0 @@
|
||||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
||||||
|
|
||||||
import cProfile
|
|
||||||
import gptc
|
|
||||||
import json
|
|
||||||
import sys
|
|
||||||
|
|
||||||
max_ngram_length = 10
|
|
||||||
|
|
||||||
with open("models/raw.json") as f:
|
|
||||||
raw_model = json.load(f)
|
|
||||||
|
|
||||||
with open("models/benchmark_text.txt") as f:
|
|
||||||
text = f.read()
|
|
||||||
|
|
||||||
cProfile.run("gptc.Model.compile(raw_model, max_ngram_length)")
|
|
|
@ -1,28 +0,0 @@
|
||||||
[build-system]
|
|
||||||
requires = ["setuptools>=61.0.0", "wheel"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "gptc"
|
|
||||||
version = "4.0.1"
|
|
||||||
description = "General-purpose text classifier"
|
|
||||||
readme = "README.md"
|
|
||||||
authors = [{ name = "Samuel Sloniker", email = "sam@kj7rrv.com"}]
|
|
||||||
classifiers = [
|
|
||||||
"Programming Language :: Python",
|
|
||||||
"Programming Language :: Python :: 3",
|
|
||||||
"Development Status :: 5 - Production/Stable",
|
|
||||||
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
|
|
||||||
"Operating System :: OS Independent",
|
|
||||||
]
|
|
||||||
dependencies = ["emoji"]
|
|
||||||
requires-python = ">=3.7"
|
|
||||||
|
|
||||||
[project.urls]
|
|
||||||
Homepage = "https://git.kj7rrv.com/kj7rrv/gptc"
|
|
||||||
|
|
||||||
[project.scripts]
|
|
||||||
gptc = "gptc.__main__:main"
|
|
||||||
|
|
||||||
[tool.setuptools]
|
|
||||||
packages = ["gptc"]
|
|
17
setup.py
Normal file
17
setup.py
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
import setuptools
|
||||||
|
|
||||||
|
with open("README.md", "r") as fh:
|
||||||
|
long_description = fh.read()
|
||||||
|
setuptools.setup(
|
||||||
|
name="gptc",
|
||||||
|
version="1.0.0",
|
||||||
|
description="General-purpose text classifier",
|
||||||
|
long_description=long_description,
|
||||||
|
long_description_content_type="text/markdown",
|
||||||
|
packages=setuptools.find_packages(),
|
||||||
|
classifiers=[
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
|
],
|
||||||
|
python_requires=">=3.6",
|
||||||
|
)
|
29
utils/pack.py
Normal file
29
utils/pack.py
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
if len(sys.argv) != 2:
|
||||||
|
print('usage: pack.py <path>', file=sys.stderr)
|
||||||
|
exit(1)
|
||||||
|
|
||||||
|
paths = os.listdir(sys.argv[1])
|
||||||
|
texts = {}
|
||||||
|
|
||||||
|
for path in paths:
|
||||||
|
texts[path] = []
|
||||||
|
try:
|
||||||
|
for file in os.listdir(os.path.join(sys.argv[1], path)):
|
||||||
|
try:
|
||||||
|
with open(os.path.join(sys.argv[1], path, file)) as f:
|
||||||
|
texts[path].append(f.read())
|
||||||
|
except Exception as e:
|
||||||
|
print(e, file=sys.stderr)
|
||||||
|
except Exception as e:
|
||||||
|
print(e, file=sys.stderr)
|
||||||
|
|
||||||
|
raw_model = []
|
||||||
|
|
||||||
|
for category, cat_texts in texts.items():
|
||||||
|
raw_model += [{'category': category, 'text': i} for i in cat_texts]
|
||||||
|
|
||||||
|
print(json.dumps(raw_model))
|
Loading…
Reference in New Issue
Block a user