momenaca commited on
Commit
e5ce9c7
·
1 Parent(s): cfaf8d8

update README file

Browse files
Files changed (1) hide show
  1. README.md +44 -0
README.md CHANGED
@@ -11,5 +11,49 @@ hf_oauth: true
11
  ---
12
 
13
  # Spinoza Project
 
14
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  WIP
 
11
  ---
12
 
13
  # Spinoza Project
14
+ 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 <a href="https://rsf.org/en/rsf-and-french-general-press-alliance-launch-spinoza-project-develop-ai-tool-journalists" target="_blank">here</a> and <a href="https://rsf.org/en/journalists-france-test-spinoza-project-s-first-ai-prototype-launched-rsf-and-alliance" target="_blank">here</a>.
15
 
16
+ A visual and guided introduction to the artificial intelligence tool can be found in the <a href="https://www.youtube.com/@reporterssansfrontieres" target="_blank">RSF's Youtube Channel</a>. You can have a look just below.
17
+
18
+ <iframe width="560" height="315" src="https://www.youtube.com/embed/iBy6IBSxRkw?si=zjissjcLEOJv7cwP" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
19
+
20
+ ## Table of Contents
21
+ - [Installation](#installation)
22
+ - [Usage](#usage)
23
+ - [Contributing](#contributing)
24
+ - [License](#license)
25
+
26
+ ## Installation
27
+ 1. Clone the repository (SSH):
28
+ ```bash
29
+ git clone https://huggingface.co/spaces/SpinozaProject/spinoza
30
+ ```
31
+
32
+ 2. Install dependencies:
33
+ ```bash
34
+ poetry install
35
+ ```
36
+
37
+ Note that we highly recommend to create a new env :
38
+ ```bash
39
+ conda create -n myenv python=3.10
40
+ conda activate myenv
41
+
42
+ pip install poetry
43
+ ```
44
+
45
+ ## Usage
46
+ To run the project in local workspace, use the following command:
47
+ ```bash
48
+ python app.py
49
+ ```
50
+
51
+ ## Contributing
52
+ 1. Clone the repository.
53
+ 2. Create a new branch: `git checkout -b feature-name`.
54
+ 3. Make your changes.
55
+ 4. Push your branch: `git push origin feature-name`.
56
+ 5. Create a pull request.
57
+
58
+ ## License
59
  WIP