init

.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ignore dynaconf secret files
+.secrets.*

LICENSE

@@ -0,0 +1,674 @@
+                    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>.

app.py

@@ -0,0 +1,55 @@
+import gradio as gr
+from ui import chat
+from ui import summary
+from models import llm_model_dict, llm_model_dict_list, \
+    embedding_model_dict_list
+from models import models
+
+block_css = """.importantButton {
+    background: linear-gradient(45deg, #7e0570,#5d1c99, #6e00ff) !important;
+    border: none !important;
+}
+.importantButton:hover {
+    background: linear-gradient(45deg, #ff00e0,#8500ff, #6e00ff) !important;
+    border: none !important;
+}"""
+
+webui_title = """
+# 🎉ChatGLM-Chinese-Summary WebUI🎉
+Link in: [https://github.com/zhongpei/ChatGLM-Chinese-Summary](https://github.com/zhongpei/ChatGLM-Chinese-Summary) 
+"""
+
+with gr.Blocks(css=block_css) as demo:
+    gr.Markdown(webui_title)
+    with gr.Tab("load model"):
+        llm_model = gr.Radio(llm_model_dict_list,
+                             label="LLM 模型",
+                             value=list(llm_model_dict.keys())[0],
+                             interactive=True)
+        llm_lora = gr.Textbox(label="lora path", value="")
+        embedding_model = gr.Radio(embedding_model_dict_list,
+                                   label="Embedding 模型",
+                                   value=embedding_model_dict_list[0],
+                                   interactive=True)
+
+        result = gr.Label("模型未加载")
+
+        load_model_button = gr.Button(
+            "重新加载模型" if models.is_active() else "加载模型"
+        )
+        load_model_button.click(
+            models.init_model,
+            show_progress=True,
+            inputs=[llm_model, llm_lora, embedding_model],
+            outputs=result
+        )
+
+    with gr.Tab("chat"):
+        chat.chat_ui(embedding_model)
+
+    with gr.Tab("Summary"):
+        summary.summary_ui()
+
+demo.queue(concurrency_count=3).launch(
+    server_name='0.0.0.0', share=False, inbrowser=False
+)

config.py

@@ -0,0 +1,13 @@
+from dynaconf import Dynaconf
+
+settings = Dynaconf(
+    envvar_prefix="DYNACONF",
+    settings_files=['settings.toml', '.secrets.toml'],
+
+)
+
+# `envvar_prefix` = export envvars with `export DYNACONF_FOO=bar`.
+# `settings_files` = Load these files in the order.
+
+llm_model_dict_list = list(llm_model_dict.keys())
+embedding_model_dict_list = list(embedding_model_dict.keys())

models.py

@@ -0,0 +1,92 @@
+import os
+
+from loguru import logger
+
+from utils.chatpdf import ChatPDF
+from utils.llm import LLM
+from utils.singleton import Singleton
+
+MAX_INPUT_LEN = 2048
+
+embedding_model_dict = {
+    "text2vec-large": "GanymedeNil/text2vec-large-chinese",
+    "text2vec-base": "shibing624/text2vec-base-chinese",
+    "sentence-transformers": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+    "ernie-tiny": "nghuyong/ernie-3.0-nano-zh",
+    "ernie-base": "nghuyong/ernie-3.0-base-zh",
+}
+
+# supported LLM models
+llm_model_dict = {
+    #"chatglm-6b": "E:\\sdwebui\\image2text_prompt_generator\\models\\chatglm-6b",
+    #"chatglm-6b-int4": "E:\\sdwebui\\image2text_prompt_generator\\models\\chatglm-6b-int4",
+    "chatglm-6b": "THUDM/chatglm-6b",
+    "chatglm-6b-int4": "THUDM/chatglm-6b-int4",
+    "llama-7b": "decapoda-research/llama-7b-hf",
+    "llama-13b": "decapoda-research/llama-13b-hf",
+    "t5-lamini-flan-783M": "MBZUAI/LaMini-Flan-T5-783M",
+}
+
+llm_model_dict_list = list(llm_model_dict.keys())
+embedding_model_dict_list = list(embedding_model_dict.keys())
+
+
+@Singleton
+class Models(object):
+
+    def __init__(self):
+        self._chatpdf = None
+        self._llm_model = None
+
+    def is_active(self):
+        return self._chatpdf is not None and self._llm_model is not None
+
+    @property
+    def chatpdf(self):
+        return self._chatpdf
+
+    @property
+    def llm_model(self):
+        return self._llm_model
+
+    def reset_model(self):
+        if self._chatpdf is not None:
+            del self._chatpdf
+
+        if self._llm_model is not None:
+            del self._llm_model
+
+        self._chatpdf = None
+        self._llm_model = None
+
+    def init_model(self, llm_model, llm_lora, embedding_model):
+        try:
+            self.reset_model()
+
+            llm_lora_path = None
+            if llm_lora is not None and os.path.exists(llm_lora):
+                llm_lora_path = llm_lora
+            self._chatpdf = ChatPDF(
+                sim_model_name_or_path=embedding_model_dict.get(
+                    embedding_model,
+                    "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2"
+                ),
+
+            )
+            self._llm_model = LLM(
+                gen_model_type=llm_model.split('-')[0],
+                gen_model_name_or_path=llm_model_dict.get(llm_model, "THUDM/chatglm-6b-int4"),
+                lora_model_name_or_path=llm_lora_path
+            )
+            if self._chatpdf is not None and self._llm_model is not None:
+                model_status = f"模型{llm_model} lora:{llm_lora} embedding:{embedding_model}已成功加载"
+            else:
+                model_status = f"llm:{self._llm_model} pdf:{self._chatpdf}加载失败"
+            logger.info(model_status)
+            return model_status
+        except Exception as e:
+            logger.error(f"加载模型失败:{e}")
+            raise e
+
+
+models = Models.instance()

requirements.txt

@@ -0,0 +1,13 @@
+gradio
+similarities>=1.0.5
+sentencepiece
+textgen
+markdown
+PyPDF2
+python-docx
+pandas
+protobuf
+cpm-kernels
+loguru
+bs4
+dynaconf

settings.toml

@@ -0,0 +1,39 @@
+[models]
+
+        [models.llm."chatglm-6b"]
+            type = "chatglm"
+            path = "THUDM/chatglm-6b"
+        [models.llm."chatglm-6b-int8"]
+            type = "chatglm"
+            path = "THUDM/chatglm-6b-int8"
+        [models.llm."chatglm-6b-int4"]
+            type = "chatglm"
+            path = "THUDM/chatglm-6b-int4"
+        [models.llm."phoenix-inst-chat-7b"]
+            type = "phoenix"
+            path = "FreedomIntelligence/phoenix-inst-chat-7b"
+        [models.llm."phoenix-inst-chat-7b-int4"]
+            type = "phoenix"
+            path = "FreedomIntelligence/phoenix-inst-chat-7b-int4"
+
+    [models.embeddings]
+        [models.embeddings."text2vec-large-chinese"]
+            type = "default"
+            path = "GanymedeNil/text2vec-large-chinese"
+        [models.embeddings."text2vec-base"]
+            type = "default"
+            path = "shibing624/text2vec-base-chinese"
+        [models.embeddings."text2vec-base"]
+            type = "default"
+            path = "shibing624/text2vec-base-chinese"
+        [models.embeddings."sentence-transformers"]
+            type = "default"
+            path = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2"
+        [models.embeddings."ernie-tiny"]
+            type = "default"
+            path = "nghuyong/ernie-3.0-nano-zh"
+        [models.embeddings."ernie-base"]
+            type = "default"
+            path = "nghuyong/ernie-3.0-base-zh"
+
+

ui/chat.py

@@ -0,0 +1,207 @@
+import gradio as gr
+import os
+import shutil
+from loguru import logger
+from utils.chatpdf import ChatPDF
+import hashlib
+from utils.llm import LLM
+from models import MAX_INPUT_LEN, models
+
+pwd_path = os.path.abspath(os.path.dirname(__file__))
+
+CONTENT_DIR = os.path.join(pwd_path, "content")
+logger.info(f"CONTENT_DIR: {CONTENT_DIR}")
+VECTOR_SEARCH_TOP_K = 3
+
+
+def get_file_list():
+    if not os.path.exists("content"):
+        return []
+    return [f for f in os.listdir("content") if
+            f.endswith(".txt") or f.endswith(".pdf") or f.endswith(".docx") or f.endswith(".md")]
+
+
+def upload_file(file, file_list):
+    if not os.path.exists(CONTENT_DIR):
+        os.mkdir(CONTENT_DIR)
+    filename = os.path.basename(file.name)
+    shutil.move(file.name, os.path.join(CONTENT_DIR, filename))
+    # file_list首位插入新上传的文件
+    file_list.insert(0, filename)
+    return gr.Dropdown.update(choices=file_list, value=filename), file_list
+
+
+def parse_text(text):
+    """copy from https://github.com/GaiZhenbiao/ChuanhuChatGPT/"""
+    lines = text.split("\n")
+    lines = [line for line in lines if line != ""]
+    count = 0
+    for i, line in enumerate(lines):
+        if "```" in line:
+            count += 1
+            items = line.split('`')
+            if count % 2 == 1:
+                lines[i] = f'<pre><code class="language-{items[-1]}">'
+            else:
+                lines[i] = f'<br></code></pre>'
+        else:
+            if i > 0:
+                if count % 2 == 1:
+                    line = line.replace("`", "\`")
+                    line = line.replace("<", "&lt;")
+                    line = line.replace(">", "&gt;")
+                    line = line.replace(" ", "&nbsp;")
+                    line = line.replace("*", "&ast;")
+                    line = line.replace("_", "&lowbar;")
+                    line = line.replace("-", "&#45;")
+                    line = line.replace(".", "&#46;")
+                    line = line.replace("!", "&#33;")
+                    line = line.replace("(", "&#40;")
+                    line = line.replace(")", "&#41;")
+                    line = line.replace("$", "&#36;")
+                lines[i] = "<br>" + line
+    text = "".join(lines)
+    return text
+
+
+def get_answer(
+        query,
+        index_path,
+        history,
+        topn: int = VECTOR_SEARCH_TOP_K,
+        max_input_size: int = 1024,
+        chat_mode: str = "pdf"
+):
+    if not models.is_active():
+        return [None, "模型还未加载"], query
+    if index_path and chat_mode == "pdf":
+        if not models.chatpdf.sim_model.corpus_embeddings:
+            models.chatpdf.load_index(index_path)
+        response, empty_history, reference_results = models.chatpdf.query(
+            llm_model=models.llm_model,
+            query=query,
+            topn=topn,
+            max_input_size=max_input_size
+        )
+
+        logger.debug(f"query: {query}, response with content: {response}")
+        for i in range(len(reference_results)):
+            r = reference_results[i]
+            response += f"\n{r.strip()}"
+        response = parse_text(response)
+        history = history + [[query, response]]
+    else:
+        # 未加载文件，仅返回生成模型结果
+        response, empty_history = models.llm_model.chat(query, history)
+        response = parse_text(response)
+        history = history + [[query, response]]
+        logger.debug(f"query: {query}, response: {response}")
+    return history, ""
+
+
+def update_status(history, status):
+    history = history + [[None, status]]
+    logger.info(status)
+    return history
+
+
+def get_file_hash(fpath):
+    return hashlib.md5(open(fpath, 'rb').read()).hexdigest()
+
+
+def get_vector_store(filepath, history, embedding_model):
+    logger.info(filepath, history)
+    index_path = None
+    file_status = ''
+    if models.chatpdf is not None:
+
+        local_file_path = os.path.join(CONTENT_DIR, filepath)
+
+        local_file_hash = get_file_hash(local_file_path)
+        index_file_name = f"{filepath}.{embedding_model}.{local_file_hash}.index.json"
+
+        local_index_path = os.path.join(CONTENT_DIR, index_file_name)
+
+        if os.path.exists(local_index_path):
+            models.chatpdf.load_index(local_index_path)
+            index_path = local_index_path
+            file_status = "文件已成功加载，请开始提问"
+
+        elif os.path.exists(local_file_path):
+            models.chatpdf.load_pdf_file(local_file_path)
+            models.chatpdf.save_index(local_index_path)
+            index_path = local_index_path
+            if index_path:
+                file_status = "文件索引并成功加载，请开始提问"
+            else:
+                file_status = "文件未成功加载，请重新上传文件"
+    else:
+        file_status = "模型未完成加载，请先在加载模型后再导入文件"
+
+    return index_path, history + [[None, file_status]]
+
+
+def reset_chat(chatbot, state):
+    return None, None
+
+
+init_message = """欢迎使用 ChatPDF Web UI，可以直接提问或上传文件后提问 """
+
+
+def chat_ui(embedding_model):
+    index_path, file_status, model_status = gr.State(""), gr.State(""), gr.State("")
+    file_list = gr.State(get_file_list())
+
+    with gr.Row():
+        with gr.Column(scale=2):
+            chatbot = gr.Chatbot([[None, init_message], [None, None]],
+                                 elem_id="chat-box",
+                                 show_label=False).style(height=700)
+            query = gr.Textbox(
+                show_label=False,
+                placeholder="请输入提问内容，按回车进行提交",
+            ).style(container=False)
+            clear_btn = gr.Button('🔄Clear!', elem_id='clear').style(full_width=True)
+
+        with gr.Column(scale=1):
+            with gr.Row():
+                chat_mode = gr.Radio(choices=["chat", "pdf"], value="pdf", label="聊天模式")
+
+            with gr.Row():
+                topn = gr.Slider(1, 100, 20, step=1, label="最大搜索数量")
+                max_input_size = gr.Slider(512, 4096, MAX_INPUT_LEN, step=10, label="摘要最大长度")
+
+            with gr.Tab("select"):
+                with gr.Row():
+                    selectFile = gr.Dropdown(
+                        file_list.value,
+                        label="content file",
+                        interactive=True,
+                        value=file_list.value[0] if len(file_list.value) > 0 else None
+                    )
+                    # get_file_list_btn = gr.Button('🔄').style(width=10)
+            with gr.Tab("upload"):
+                file = gr.File(
+                    label="content file",
+                    file_types=['.txt', '.md', '.docx', '.pdf']
+                )
+            load_file_button = gr.Button("加载文件")
+
+    # 将上传的文件保存到content文件夹下,并更新下拉框
+    file.upload(
+        upload_file,
+        inputs=[file, file_list],
+        outputs=[selectFile, file_list]
+    )
+    load_file_button.click(
+        get_vector_store,
+        show_progress=True,
+        inputs=[selectFile, chatbot, embedding_model],
+        outputs=[index_path, chatbot],
+    )
+    query.submit(
+        get_answer,
+        [query, index_path, chatbot, topn, max_input_size, chat_mode],
+        [chatbot, query],
+    )
+    clear_btn.click(reset_chat, [chatbot, query], [chatbot, query])

ui/summary.py

@@ -0,0 +1,179 @@
+import re
+
+import gradio as gr
+from typing import List
+from models import models
+from loguru import logger
+import re
+
+PROMPT_TEMPLATE = """\
+使用中文{query_str}:
+{context_str}
+"""
+
+
+def get_text_lines(input_txt: str) -> List[str]:
+    lines = input_txt.splitlines()
+    lines = [line.strip() for line in lines if line.strip()]
+    return lines
+
+
+stop_chars_set = {
+    '.', '!', '?', '。', '！', '？', '…', ';', '；', ':', '：',
+    '”', '’', '）', '】', '》', '」', '』', '〕', '〉',
+    '》', '〗', '〞', '〟', '»', '"', "'", ')', ']', '}'
+}
+
+
+def split_in_line(input_txt: str, limit_length: int) -> List[str]:
+    new_text = ''
+    contents = []
+    outputs = []
+    for text in input_txt:
+        new_text += text
+        if text in stop_chars_set:
+            contents.append(new_text)
+            # logger.debug(f"{new_text}")
+            new_text = ''
+    # logger.debug(f"{input_txt[-1]} {input_txt[-1] not in stop_chars_set} {new_text}")
+    if input_txt[-1] not in stop_chars_set:
+        contents.append(new_text)
+
+    text = ""
+    text_length = 0
+    for idx, content in enumerate(contents):
+        text += content
+        text_length += len(content)
+        if text_length >= limit_length:
+            outputs.append(text)
+            text = ""
+            text_length = 0
+    if text_length < limit_length:
+        outputs.append(text)
+    return outputs
+
+
+def get_text_limit_length(input_txt: str, max_length: int = 2048) -> List[str]:
+    lines = get_text_lines(input_txt)
+    output: List[str] = []
+    for line in lines:
+        if len(line) <= max_length:
+            output.append(line)
+        else:
+            text_lines = split_in_line(line, max_length)
+            logger.debug(f"split in line: {len(text_lines)}")
+            # logger.debug(f"{line} ==> {text_lines}")
+            output.extend(text_lines)
+    return output
+
+
+def split_input_text(input_txt, strip_input_lines=0, max_length=2048):
+    if strip_input_lines > 0:
+        pattern = r'[\r\n]{' + str(strip_input_lines) + r',}'
+        re.compile(pattern=pattern)
+        logger.debug(f"strip input txt: {pattern}")
+        input_txt = re.sub(pattern, '', input_txt)
+    lines = get_text_limit_length(input_txt, max_length)
+    logger.debug(f"split input txt: {len(lines)}")
+    return "\n\n\n".join(lines)
+
+
+def gen_keyword_summary(input_txt, keyword_prompt, summary_prompt, max_length=2048):
+    lines = input_txt.split("\n\n\n")
+    keywords_output = []
+    for line in lines:
+        keywords = models.llm_model.generate_answer(
+            keyword_prompt,
+            line,
+            history=None,
+            max_length=max_length,
+            prompt_template=PROMPT_TEMPLATE
+        )[0]
+        logger.debug(f"text len: {len(line)} ==> {keywords}")
+        keywords_output.extend(keywords.split())
+    keywords_output = [keyword.strip() for keyword in keywords_output if keyword.strip() != ""]
+    keywords_output = list(set(keywords_output))
+    return f"保留关键词:{' '.join(keywords_output)},{summary_prompt}"
+
+
+def gen_summary(input_txt, summary_prompt, max_length=2048):
+    lines = input_txt.split("\n\n\n")
+    output_summary = []
+    summary = ""
+    for idx, line in enumerate(lines):
+        if idx == 1:
+            summary = models.llm_model.generate_answer(
+                summary_prompt,
+                line,
+                history=None,
+                max_length=max_length,
+                prompt_template=PROMPT_TEMPLATE
+            )[0]
+            logger.debug(f"text len: {len(line)} ==> {summary}")
+        else:
+            summary = models.llm_model.generate_answer(
+                summary_prompt,
+                f"{summary}{line}",
+                history=None,
+                max_length=max_length,
+                prompt_template=PROMPT_TEMPLATE
+            )[0]
+            logger.debug(f"summary: {len(summary)} + text: {len(line)}  ==> {summary}")
+        output_summary.append(summary)
+
+    return "\n\n\n".join(output_summary)
+
+
+def summary_ui():
+    with gr.Row():
+        with gr.Column(scale=1):
+            line_max_length = gr.Slider(minimum=512, maximum=4096, step=1, value=1024, label="每行最大长度")
+            strip_input_lines = gr.Slider(
+                label="去除输入文本连续的空行(0:不除去)",
+                minimum=1,
+                maximum=10,
+                step=1,
+                value=0
+            )
+        with gr.Column(scale=4):
+            keyword_prompt = gr.Textbox(
+                lines=1,
+                label="抽取关键词",
+                value="抽取以下内容的人物和地点:",
+                placeholder="请输入抽取关键词的Prompt"
+            )
+            summary_prompt = gr.Textbox(
+                lines=2,
+                label="生成摘要",
+                value="生成以下内容的摘要:",
+                placeholder="请输入生成摘要的Prompt"
+            )
+    keyword_summary_prompt = gr.Textbox(lines=4, label="关键词+摘要", placeholder="请输入关键词+摘要的Prompt")
+
+    with gr.Row():
+        input_text = gr.Textbox(lines=20, max_lines=60, label="输入文本", placeholder="请输入文本")
+        split_text = gr.Textbox(lines=20, max_lines=60, label="分段文本", placeholder="请输入分段文本")
+        summary = gr.Textbox(lines=20, max_lines=60, label="生成摘要", placeholder="请输入生成摘要的Prompt")
+
+    with gr.Row():
+        btn_split = gr.Button("分段")
+        btn_keyword = gr.Button("提取关键词")
+        btn_summary = gr.Button("生成摘要")
+
+    btn_split.click(
+        split_input_text,
+        inputs=[input_text, strip_input_lines, line_max_length],
+        outputs=[split_text]
+    )
+
+    btn_summary.click(
+        gen_summary,
+        inputs=[split_text, keyword_summary_prompt, line_max_length],
+        outputs=[summary]
+    )
+
+    btn_keyword.click(
+        gen_keyword_summary,
+        inputs=[split_text, keyword_prompt, summary_prompt, line_max_length],
+        outputs=[keyword_summary_prompt]
+    )

utils/chatpdf.py

@@ -0,0 +1,157 @@
+from similarities import Similarity
+from textgen import ChatGlmModel, LlamaModel
+from transformers import pipeline
+from loguru import logger
+import torch
+
+device_id = 0 if torch.cuda.is_available() else -1
+
+PROMPT_TEMPLATE = """\
+基于以下已知信息，简洁和专业的来回答用户的问题。
+如果无法从中得到答案，请说 "根据已知信息无法回答该问题" 或 "没有提供足够的相关信息"，不允许在答案中添加编造成分，答案请使用中文。
+
+已知内容:
+{context_str}
+
+问题:
+{query_str}
+"""
+
+
+class ChatPDF:
+    def __init__(
+            self,
+            sim_model_name_or_path: str = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+
+    ):
+        self.sim_model = Similarity(model_name_or_path=sim_model_name_or_path)
+
+        self.history = None
+        self.pdf_path = None
+
+    def load_pdf_file(self, pdf_path: str):
+        """Load a PDF file."""
+        if pdf_path.endswith('.pdf'):
+            corpus = self.extract_text_from_pdf(pdf_path)
+        elif pdf_path.endswith('.docx'):
+            corpus = self.extract_text_from_docx(pdf_path)
+        elif pdf_path.endswith('.md'):
+            corpus = self.extract_text_from_markdown(pdf_path)
+        else:
+            corpus = self.extract_text_from_txt(pdf_path)
+        self.sim_model.add_corpus(corpus)
+        self.pdf_path = pdf_path
+
+    @staticmethod
+    def extract_text_from_pdf(file_path: str):
+        """Extract text content from a PDF file."""
+        import PyPDF2
+        contents = []
+        with open(file_path, 'rb') as f:
+            pdf_reader = PyPDF2.PdfReader(f)
+            for page in pdf_reader.pages:
+                page_text = page.extract_text().strip()
+                raw_text = [text.strip() for text in page_text.splitlines() if text.strip()]
+                new_text = ''
+                for text in raw_text:
+                    new_text += text
+                    if text[-1] in ['.', '!', '?', '。', '！', '？', '…', ';', '；', ':', '：', '”', '’', '）', '】', '》', '」',
+                                    '』', '〕', '〉', '》', '〗', '〞', '〟', '»', '"', "'", ')', ']', '}']:
+                        contents.append(new_text)
+                        new_text = ''
+                if new_text:
+                    contents.append(new_text)
+        return contents
+
+    @staticmethod
+    def extract_text_from_txt(file_path: str):
+        """Extract text content from a TXT file."""
+        contents = []
+        with open(file_path, 'r', encoding='utf-8') as f:
+            contents = [text.strip() for text in f.readlines() if text.strip()]
+        return contents
+
+    @staticmethod
+    def extract_text_from_docx(file_path: str):
+        """Extract text content from a DOCX file."""
+        import docx
+        document = docx.Document(file_path)
+        contents = [paragraph.text.strip() for paragraph in document.paragraphs if paragraph.text.strip()]
+        return contents
+
+    @staticmethod
+    def extract_text_from_markdown(file_path: str):
+        """Extract text content from a Markdown file."""
+        import markdown
+        from bs4 import BeautifulSoup
+        with open(file_path, 'r', encoding='utf-8') as f:
+            markdown_text = f.read()
+        html = markdown.markdown(markdown_text)
+        soup = BeautifulSoup(html, 'html.parser')
+        contents = [text.strip() for text in soup.get_text().splitlines() if text.strip()]
+        return contents
+
+    @staticmethod
+    def _add_source_numbers(lst):
+        """Add source numbers to a list of strings."""
+        return [f'[{idx + 1}]\t "{item}"' for idx, item in enumerate(lst)]
+
+    def query(
+            self,
+            llm_model,
+            query,
+            topn: int = 5,
+            max_length: int = 1024,
+            max_input_size: int = 1024,
+            use_history: bool = False,
+
+    ):
+        """Query from corpus."""
+
+        sim_contents = self.sim_model.most_similar(query, topn=topn)
+
+        reference_results = []
+        for query_id, id_score_dict in sim_contents.items():
+            for corpus_id, s in id_score_dict.items():
+                reference_results.append(self.sim_model.corpus[corpus_id])
+        if not reference_results:
+            return '没有提供足够的相关信息', reference_results
+        reference_results = self._add_source_numbers(reference_results)
+
+        context_str = '\n'.join(reference_results)[:(max_input_size - len(PROMPT_TEMPLATE))]
+
+        if use_history:
+            response, out_history = llm_model.generate_answer(query, context_str, self.history, max_length=max_length)
+            self.history = out_history
+        else:
+            response, out_history = llm_model.generate_answer(query, context_str)
+
+        return response, out_history, reference_results
+
+    def save_index(self, index_path=None):
+        """Save model."""
+        if index_path is None:
+            index_path = '.'.join(self.pdf_path.split('.')[:-1]) + '_index.json'
+        self.sim_model.save_index(index_path)
+
+    def load_index(self, index_path=None):
+        """Load model."""
+        if index_path is None:
+            index_path = '.'.join(self.pdf_path.split('.')[:-1]) + '_index.json'
+        self.sim_model.load_index(index_path)
+
+
+if __name__ == "__main__":
+    import sys
+
+    if len(sys.argv) > 2:
+        gen_model_name_or_path = sys.argv[1]
+    else:
+        print('Usage: python chatpdf.py <gen_model_name_or_path>')
+        gen_model_name_or_path = "THUDM/chatglm-6b-int4"
+    m = ChatPDF(gen_model_name_or_path=gen_model_name_or_path)
+    m.load_pdf_file(pdf_path='sample.pdf')
+    response = m.query('自然语言中的非平行迁移是指什么？')
+    print(response[0])
+    response = m.query('本文作者是谁？')
+    print(response[0])

utils/llm.py

@@ -0,0 +1,50 @@
+from textgen import ChatGlmModel, LlamaModel
+from loguru import logger
+
+
+class LLM(object):
+    def __init__(
+            self,
+            gen_model_type: str = "chatglm",
+            gen_model_name_or_path: str = "THUDM/chatglm-6b-int4",
+            lora_model_name_or_path: str = None,
+
+    ):
+
+        self.model_type = gen_model_type
+
+        if gen_model_type == "chatglm":
+            self.gen_model = ChatGlmModel(
+                gen_model_type,
+                gen_model_name_or_path,
+                lora_name=lora_model_name_or_path,
+            )
+        elif gen_model_type == "llama":
+
+            self.gen_model = LlamaModel(
+                gen_model_type,
+                gen_model_name_or_path,
+                lora_name=lora_model_name_or_path,
+            )
+
+        else:
+            raise ValueError('gen_model_type must be chatglm or llama.')
+        self.history = None
+
+    def generate_answer(self, query_str, context_str, history=None, max_length=1024, prompt_template=None):
+        """Generate answer from query and context."""
+        if self.model_type == "t5":
+            response = self.gen_model(query_str, max_length=max_length, do_sample=True)[0]['generated_text']
+            return response, history
+        prompt = prompt_template.format(context_str=context_str, query_str=query_str)
+        response, out_history = self.gen_model.chat(prompt, history, max_length=max_length)
+        return response, out_history
+
+    def chat(self, query_str, history=None, max_length=1024):
+        if self.model_type == "t5":
+            response = self.gen_model(query_str, max_length=max_length, do_sample=True)[0]['generated_text']
+            logger.debug(response)
+            return response, history
+
+        response, out_history = self.gen_model.chat(query_str, history, max_length=max_length)
+        return response, out_history

utils/singleton.py

@@ -0,0 +1,37 @@
+class Singleton:
+    """
+    A non-thread-safe helper class to ease implementing singletons.
+    This should be used as a decorator -- not a metaclass -- to the
+    class that should be a singleton.
+
+    The decorated class can define one `__init__` function that
+    takes only the `self` argument. Also, the decorated class cannot be
+    inherited from. Other than that, there are no restrictions that apply
+    to the decorated class.
+
+    To get the singleton instance, use the `instance` method. Trying
+    to use `__call__` will result in a `TypeError` being raised.
+
+    """
+
+    def __init__(self, decorated):
+        self._decorated = decorated
+
+    def instance(self):
+        """
+        Returns the singleton instance. Upon its first call, it creates a
+        new instance of the decorated class and calls its `__init__` method.
+        On all subsequent calls, the already created instance is returned.
+
+        """
+        try:
+            return self._instance
+        except AttributeError:
+            self._instance = self._decorated()
+            return self._instance
+
+    def __call__(self):
+        raise TypeError('Singletons must be accessed through `instance()`.')
+
+    def __instancecheck__(self, inst):
+        return isinstance(inst, self._decorated)