Commit
·
c28176d
1
Parent(s):
bce761b
Update version numbers and readme
Browse files- README.md +9 -8
- pyproject.toml +1 -1
README.md
CHANGED
@@ -10,7 +10,7 @@ license: agpl-3.0
|
|
10 |
---
|
11 |
# Document redaction
|
12 |
|
13 |
-
version: 0.6.
|
14 |
|
15 |
Redact personally identifiable information (PII) from documents (pdf, images), open text, or tabular data (xlsx/csv/parquet). Please see the [User Guide](#user-guide) for a walkthrough on how to use the app. Below is a very brief overview.
|
16 |
|
@@ -223,13 +223,13 @@ On the 'Review redactions' tab you have a visual interface that allows you to in
|
|
223 |
|
224 |
### Uploading documents for review
|
225 |
|
226 |
-
The top area has a file upload area where you can upload original, unredacted PDFs, alongside the '..._review_file.csv' that is produced by the redaction process. Once you have uploaded these two files, click the 'Review PDF
|
227 |
|
228 |
Optionally, you can also upload one of the '..._ocr_output.csv' files here that comes out of a redaction task, so that you can navigate the extracted text from the document.
|
229 |
|
230 |

|
231 |
|
232 |
-
You can upload the three review files in the box (unredacted document, '..._review_file.csv' and '..._ocr_output.csv' file) before clicking 'Review PDF
|
233 |
|
234 |

|
235 |
|
@@ -293,7 +293,7 @@ The table shows a list of all the suggested redactions in the document alongside
|
|
293 |
|
294 |

|
295 |
|
296 |
-
If you click on one of the rows in this table, you will be taken to the page of the redaction. Clicking on a redaction row on the same page
|
297 |
|
298 |

|
299 |
|
@@ -303,12 +303,13 @@ To filter the 'Search suggested redactions' table you can:
|
|
303 |
1. Click on one of the dropdowns (Redaction category, Page, Text), and select an option, or
|
304 |
2. Write text in the 'Filter' box just above the table. Click the blue box to apply the filter to the table.
|
305 |
|
306 |
-
Once you have filtered the table, you have a few options underneath on what you can do with the filtered rows:
|
307 |
|
308 |
-
- Click the
|
309 |
-
- Click the
|
|
|
310 |
|
311 |
-
**NOTE**: After excluding redactions using
|
312 |
|
313 |
If you made a mistake, click the 'Undo last element removal' button to restore the Search suggested redactions table to its previous state (can only undo the last action).
|
314 |
|
|
|
10 |
---
|
11 |
# Document redaction
|
12 |
|
13 |
+
version: 0.6.8
|
14 |
|
15 |
Redact personally identifiable information (PII) from documents (pdf, images), open text, or tabular data (xlsx/csv/parquet). Please see the [User Guide](#user-guide) for a walkthrough on how to use the app. Below is a very brief overview.
|
16 |
|
|
|
223 |
|
224 |
### Uploading documents for review
|
225 |
|
226 |
+
The top area has a file upload area where you can upload original, unredacted PDFs, alongside the '..._review_file.csv' that is produced by the redaction process. Once you have uploaded these two files, click the '**Review redactions based on original PDF...**' button to load in the files for review. This will allow you to visualise and modify the suggested redactions using the interface below.
|
227 |
|
228 |
Optionally, you can also upload one of the '..._ocr_output.csv' files here that comes out of a redaction task, so that you can navigate the extracted text from the document.
|
229 |
|
230 |

|
231 |
|
232 |
+
You can upload the three review files in the box (unredacted document, '..._review_file.csv' and '..._ocr_output.csv' file) before clicking '**Review redactions based on original PDF...**', as in the image below:
|
233 |
|
234 |

|
235 |
|
|
|
293 |
|
294 |

|
295 |
|
296 |
+
If you click on one of the rows in this table, you will be taken to the page of the redaction. Clicking on a redaction row on the same page will change the colour of redaction box to blue to help you locate it in the document viewer (just when using the app, not in redacted output PDFs).
|
297 |
|
298 |

|
299 |
|
|
|
303 |
1. Click on one of the dropdowns (Redaction category, Page, Text), and select an option, or
|
304 |
2. Write text in the 'Filter' box just above the table. Click the blue box to apply the filter to the table.
|
305 |
|
306 |
+
Once you have filtered the table, or selected a row from the table, you have a few options underneath on what you can do with the filtered rows:
|
307 |
|
308 |
+
- Click the **Exclude all redactions in table** button to remove all redactions visible in the table from the document. **Important:** ensure that you have clicked the blue tick icon next to the search box before doing this, or you will remove all redactions from the document. If you do end up doing this, click the 'Undo last element removal' button below to restore the redactions.
|
309 |
+
- Click the **Exclude specific redaction row** button to remove only the redaction from the last row you clicked on from the document. The currently selected row is visible below.
|
310 |
+
- Click the **Exclude all redactions with the same text as selected row** button to remove all redactions from the document that are exactly the same as the selected row text.
|
311 |
|
312 |
+
**NOTE**: After excluding redactions using any of the above options, click the 'Reset filters' button below to ensure that the dropdowns and table return to seeing all remaining redactions in the document.
|
313 |
|
314 |
If you made a mistake, click the 'Undo last element removal' button to restore the Search suggested redactions table to its previous state (can only undo the last action).
|
315 |
|
pyproject.toml
CHANGED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
4 |
|
5 |
[project]
|
6 |
name = "doc_redaction"
|
7 |
-
version = "0.6.
|
8 |
description = "Redact PDF/image-based documents, or CSV/XLSX files using a Gradio-based GUI interface"
|
9 |
readme = "README.md"
|
10 |
requires-python = ">=3.10"
|
|
|
4 |
|
5 |
[project]
|
6 |
name = "doc_redaction"
|
7 |
+
version = "0.6.8"
|
8 |
description = "Redact PDF/image-based documents, or CSV/XLSX files using a Gradio-based GUI interface"
|
9 |
readme = "README.md"
|
10 |
requires-python = ">=3.10"
|