extralit-server 0.1.0a0__tar.gz

extralit_server-0.1.0a0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

extralit_server-0.1.0a0/PKG-INFO

@@ -0,0 +1,315 @@
+Metadata-Version: 2.1
+Name: extralit-server
+Version: 0.1.0a0
+Summary: Open-source tool for accurate & fast scientific literature data extraction with LLM and human-in-the-loop.
+Keywords: literature-review,data-annotation,artificial-intelligence,machine-learning,human-in-the-loop,mlops
+Home-page: https://www.argilla.io
+Author-Email: Jonny Tran <nhat.c.tran@gmail.com>, argilla <contact@argilla.io>
+Maintainer-Email: Jonny Tran <nhat.c.tran@gmail.com>, argilla <contact@argilla.io>
+License: Apache-2.0
+Project-URL: Homepage, https://www.argilla.io
+Project-URL: Documentation, https://docs.argilla.io
+Project-URL: Repository, https://github.com/argilla-io/argilla
+Requires-Python: <3.11,>=3.9
+Requires-Dist: pydantic
+Requires-Dist: rich!=13.1.0
+Requires-Dist: tqdm
+Requires-Dist: python-dotenv
+Requires-Dist: fastapi<1.0.0,>=0.103.1; extra == "argilla-server"
+Requires-Dist: pydantic<2.0,>=1.10.7; extra == "argilla-server"
+Requires-Dist: uvicorn[standard]<0.25.0,>=0.15.0; extra == "argilla-server"
+Requires-Dist: opensearch-py~=2.0.0; extra == "argilla-server"
+Requires-Dist: elasticsearch8[async]~=8.7.0; extra == "argilla-server"
+Requires-Dist: smart-open; extra == "argilla-server"
+Requires-Dist: brotli-asgi<1.3,>=1.1; extra == "argilla-server"
+Requires-Dist: alembic~=1.9.0; extra == "argilla-server"
+Requires-Dist: SQLAlchemy~=2.0.0; extra == "argilla-server"
+Requires-Dist: greenlet>=2.0.0; extra == "argilla-server"
+Requires-Dist: aiosqlite>=0.19.0; extra == "argilla-server"
+Requires-Dist: scikit-learn>=0.24.2; extra == "argilla-server"
+Requires-Dist: aiofiles<22.2,>=0.6; extra == "argilla-server"
+Requires-Dist: PyYAML<6.1.0,>=5.4.1; extra == "argilla-server"
+Requires-Dist: python-multipart~=0.0.5; extra == "argilla-server"
+Requires-Dist: python-jose[cryptography]<3.4,>=3.2; extra == "argilla-server"
+Requires-Dist: passlib[bcrypt]~=1.7.4; extra == "argilla-server"
+Requires-Dist: httpx~=0.26.0; extra == "argilla-server"
+Requires-Dist: oauthlib~=3.2.0; extra == "argilla-server"
+Requires-Dist: social-auth-core~=4.5.0; extra == "argilla-server"
+Requires-Dist: psutil<5.10,>=5.8; extra == "argilla-server"
+Requires-Dist: segment-analytics-python==2.2.0; extra == "argilla-server"
+Requires-Dist: rich!=13.1.0; extra == "argilla-server"
+Requires-Dist: typer<0.10.0,>=0.6.0; extra == "argilla-server"
+Requires-Dist: packaging>=23.2; extra == "argilla-server"
+Requires-Dist: minio>=7.2.7; extra == "argilla-server"
+Requires-Dist: psycopg2~=2.9.5; extra == "postgresql"
+Requires-Dist: asyncpg>=0.27.0; extra == "postgresql"
+Requires-Dist: minio; extra == "extraction"
+Requires-Dist: argilla; extra == "extraction"
+Requires-Dist: hypothesis; extra == "extraction"
+Requires-Dist: html5lib; extra == "extraction"
+Requires-Dist: fastapi<1.0.0; extra == "extraction"
+Requires-Dist: pydantic; extra == "extraction"
+Requires-Dist: pypandoc~=1.13; extra == "extraction"
+Requires-Dist: weaviate-client~=4.5.7; extra == "extraction"
+Requires-Dist: beautifulsoup4~=4.12.2; extra == "extraction"
+Requires-Dist: pandas~=2.2.2; extra == "extraction"
+Requires-Dist: pandera[io]~=0.19.3; extra == "extraction"
+Requires-Dist: numpy~=1.26.4; extra == "extraction"
+Requires-Dist: spacy~=3.7.2; extra == "extraction"
+Requires-Dist: pyarrow==14.*; extra == "extraction"
+Requires-Dist: natsort~=8.4.0; extra == "extraction"
+Requires-Dist: rapidfuzz~=3.8.1; extra == "extraction"
+Requires-Dist: dill~=0.3.8; extra == "extraction"
+Requires-Dist: json-repair~=0.19.2; extra == "extraction"
+Requires-Dist: fastparquet; extra == "extraction"
+Requires-Dist: textdescriptives; extra == "nlp"
+Requires-Dist: setfit~=0.7.0; extra == "nlp"
+Requires-Dist: nougat-ocr[api]; extra == "ocr"
+Requires-Dist: timm==0.5.4; extra == "ocr"
+Requires-Dist: unstructured[pdf]~=0.12.3; extra == "pdf"
+Requires-Dist: deepdoctection~=0.31.0; extra == "pdf"
+Requires-Dist: llmsherpa~=0.1.3; extra == "pdf"
+Requires-Dist: python-doctr~=0.8.1; extra == "pdf"
+Requires-Dist: pypdf; extra == "pdf"
+Requires-Dist: pypdfium2; extra == "pdf"
+Requires-Dist: pdf2image~=1.16.0; extra == "pdf"
+Requires-Dist: llama-index~=0.10.40; extra == "llm"
+Requires-Dist: llama-index-core~=0.10.40; extra == "llm"
+Requires-Dist: llama-index-vector-stores-weaviate~=1.0.0; extra == "llm"
+Requires-Dist: llama-index-callbacks-langfuse~=0.1.4; extra == "llm"
+Requires-Dist: llama-index-llms-openai; extra == "llm"
+Requires-Dist: llama-index-embeddings-openai; extra == "llm"
+Requires-Dist: llama-index-multi-modal-llms-openai; extra == "llm"
+Provides-Extra: argilla-server
+Provides-Extra: postgresql
+Provides-Extra: extraction
+Provides-Extra: nlp
+Provides-Extra: ocr
+Provides-Extra: pdf
+Provides-Extra: llm
+Description-Content-Type: text/markdown
+
+
+<h1 align="center">
+  <a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
+  <br>
+  Extralit
+  <br>
+</h1>
+
+<h2 align="center">Open-source feedback layer for LLM-assisted data extractions</h2>
+
+<h3>
+<p align="center">
+<a href="https://docs.argilla.io">📄 Documentation</a> | </span>
+<a href="#-quickstart">🚀 Quickstart</a> <span> | </span>
+<a href="#-project-architecture">🛠️ Architecture</a> <span> | </span>
+</p>
+</h3>
+
+## What is Extralit?
+
+Extralit is a UI interface and platform for LLM-based document data extraction that integrates human and model feedback loops for continuous LLM refinement and data extraction oversight.
+
+With a Python SDK and flexible UI, you can create human and model-in-the-loop workflows for:
+
+* Data extraction validation
+* Supervised fine-tuning
+* Preference tuning (RLHF, DPO, RLAIF, and more)
+* Small, specialized NLP models
+* Scalable evaluation.
+
+## 🚀 Development Quickstart
+
+### Install the Pre-requisites
+These steps are required to run and develop Argilla locally.
+
+1. Install [Docker Desktop](https://docs.docker.com/get-docker/)
+2. Install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
+2. Install [ctlptl](https://github.com/tilt-dev/ctlptl/tree/main#how-do-i-install-it)
+3. Install [Tilt](https://docs.tilt.dev/)
+
+### Set up local infrastructure for Kind
+
+1. Create a `kind` cluster
+
+```bash
+ctlptl create registry ctlptl-registry --port=5005
+ctlptl create cluster kind --registry=ctlptl-registry
+```
+
+
+2. Apply config to mount local directory
+
+```bash
+ctlptl apply -f k8s/kind/kind-config.yaml
+kubectl taint node kind-control-plane node-role.kubernetes.io/control-plane:NoSchedule-
+
+```
+
+### Start local development
+
+1. Run Tilt 
+
+Select the K8s cluster
+```bash
+kubectl config set-cluster <cluster_name>
+```
+
+Setting the `ENV` variable to `dev` enables hot-reloading of Docker containers for 🚀 rapid deployment:
+```bash
+kubectl create ns <namespace>
+ENV=dev tilt up --namespace=<namespace>
+```
+
+### Start staging/prod K8s deployment
+
+```bash
+ENV=dev DOCKER_REPO=<remote docker repository> tilt up --namespace <namespace> --context <K8s cluster context>
+```
+
+## 🛠️ Developer guide
+
+### Editing database schema:
+Editting the database schema files at `src/argilla/server/models/*.py` require running these commands to apply revisions to the database.
+
+1. Create revision
+```bash
+cd src/argilla
+alembic revision -m <message>
+```
+
+If you happen to run into errors due to the revisions from upstream argilla-io/argilla repo, set the down-revision tag to their latest in the revision `"7552df94427a"` at `src/argilla/server/alembic/versions`
+
+2. Apply the revision
+```bash
+# Be sure to set environment variables ARGILLA_ELASTICSEARCH and ARGILLA_DATABASE_URL
+python -m argilla server database migrate
+```
+
+3. Update frontend site to the API backend
+
+```bash
+bash scripts/build_frontend.sh
+python setup.py bdist_wheel
+```
+
+## 🛠️ Project Architecture
+
+Argilla is built on 5 core components:
+
+- **Python SDK**: A Python SDK which is installable with `pip install argilla`. To interact with the Argilla Server and the Argilla UI. It provides an API to manage the data, configuration and annotation workflows.
+- **FastAPI Server**: The core of Argilla is a *Python FastAPI* server that manages the data, by pre-processing it and storing it in the vector database. Also, it stores application information in the relational database. It provides a REST API to interact with the data from the Python SDK and the Argilla UI. It also provides a web interface to visualize the data.
+- **Relational Database**: A relational database to store the metadata of the records and the annotations. *SQLite* is used as the default built-in option and is deployed separately with the Argilla Server but a separate *PostgreSQL* can be used too.
+- **Vector Database**: A vector database to store the records data and perform scalable vector similarity searches and basic document searches. We currently support *ElasticSearch* and *AWS OpenSearch* and they can be deployed as separate Docker images.
+- **Vue.js UI**: A web application to visualize and annotate your data, users and teams. It is built with *Vue.js* and is directly deployed alongside the Argilla Server within our Argilla Docker image.
+
+
+
+<p align="center">
+<a  href="https://pypi.org/project/argilla-server/">
+<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
+</a>
+<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla-server/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
+<a href="https://pepy.tech/project/argilla-server">
+<img alt="CI" src="https://static.pepy.tech/personalized-badge/argilla-server?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
+</a>
+<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
+<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
+</a>
+</p>
+
+<p align="center">
+<a href="https://twitter.com/argilla_io">
+<img src="https://img.shields.io/badge/twitter-black?logo=x"/>
+</a>
+<a href="https://www.linkedin.com/company/argilla-io">
+<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
+</a>
+<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
+<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
+</a>
+</p>
+
+
+## Clone repository
+
+`argilla-server` is using `argilla` repository as submodule to build frontend statics so when cloning use the following command:
+
+```sh
+git clone --recurse-submodules git@github.com:argilla-io/argilla-server.git
+```
+
+If you already cloned the repository without using `--recurse-submodules` you can init and update the submodules with:
+
+```sh
+git submodule update --remote --recursive --init
+```
+
+> [!IMPORTANT]
+> By default `argilla` submodule is using `develop` branch so the previous command will get the latest commit from that branch.
+
+### Specify a tag for argilla submodule
+
+When doing a release we should change `argilla` submodule to use an specific tag. In the following example we are setting tag `v1.22.0`:
+
+```sh
+cd argilla
+git fetch --tags
+git checkout v1.22.0
+```
+
+> [!NOTE]
+> You should see some changes on the `argilla-server` root folder where the subproject commit is now changed to the one from the tag version. Feel free to commit these changes.
+
+## Development environment
+
+By default all commands executed with `pdm run` will get environment variables from `.env.dev` except command `pdm test` that will overwrite some of them using values coming from `.env.test` file.
+
+These environment variables can be overrided if necessary so feel free to defined your own ones locally.
+
+### Run cli
+
+```sh
+pdm cli
+```
+
+### Run database migrations
+
+By default a SQLite located at `~/.argilla/argilla.db` will be used. You can create the database and run migrations with the following custom PDM command:
+
+```sh
+pdm migrate
+```
+
+### Run tests
+
+A SQLite database located at `~/.argilla/argilla-test.db` will be automatically created to run tests. You can run the entire test suite using the following custom PDM command:
+
+```sh
+pdm test
+```
+
+## Run development server
+
+### Build frontend static files
+
+Before running Argilla development server we need to build the frontend static files. Node version 18 is required for this action:
+
+```sh
+brew install node@18
+```
+
+After that you can build the frontend static files:
+
+```sh
+./scripts/build_frontend.sh
+```
+
+After running the previous script you should have a folder at `src/argilla_server/static` with all the frontend static files successfully generated.
+
+### Run uvicorn development server
+
+```sh
+pdm server
+```