README.md

metadata

title: Spinoza
emoji: 🐨
colorFrom: green
colorTo: indigo
sdk: gradio
sdk_version: 4.37.2
app_file: app.py
pinned: false
hf_oauth: true

Spinoza Project

Reporters Without Borders (RSF) has teamed up with the General Information Press Alliance (the Alliance) to initiate the first step of its Spinoza project to develop an artificial intelligence tool by and for journalists that will safeguard the media’s intellectual property over what they publish. You can find more information here and here.

A visual and guided introduction to the artificial intelligence tool can be found in the RSF's Youtube Channel. You can have a look just below.

Table of Contents

• Documentation
• Installation
• Usage
• Contributing
• License

Documentation

For a step-by-step guide on how to replicate Spinoza in a private space and integrate your own specialized "sub-RAG" using Google Colab, please refer to our Tutorial for Replication.

Installation

1. Clone the repository (SSH):

 git clone https://huggingface.co/spaces/SpinozaProject/spinoza

2. Install dependencies:

 poetry install

Note that we highly recommend to create a new env :

 conda create -n myenv python=3.10
 conda activate myenv

 pip install poetry

Usage

To run the project in local workspace, use the following command:

python app.py

Contributing

1. Clone the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes.
4. Push your branch: git push origin feature-name.
5. Create a pull request.

License

WIP