Skip to content

Commit

Permalink
fixing readme.rst as not being uploaded to pypi due to errors
Browse files Browse the repository at this point in the history
  • Loading branch information
coliin8 committed Feb 29, 2024
1 parent a39e6b1 commit c435de4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.7.3
current_version = 0.7.2
commit = True
tag = True
tag_name = {new_version}
Expand Down
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,13 +192,15 @@ Here an example:
Batch processing
######################

The batch processing is implemented in the class ``NerdBatch``.
The class can be instantiated by defining the entity-fishing url in the constructor, else the default one is used.

To run the processing, the method `process` requires the `input` directory, a callback and the number of threads/processes.
There is an already ready implementation in `script/batchSample.py`.

To run it:

- under this work branch, prepare two folders: `input` which containing the input Pdf files to be processed and `output` which collecting the processing result
- we recommend to create a new virtualenv, activate it and install all the requirements needed in this virtual environment using `$ pip install -r /path/of/entity-fishing-client-python/source/requirements.txt`
- (temporarly, until this branch is not merged) install entity-fishing **multithread branch** in edit mode (`pip install -e /path/of/entity-fishing-client-python/source`)
Expand All @@ -207,6 +209,7 @@ To run it:

KB access
#########

.. code-block:: python
nerd.get_concept("Q456")
Expand Down Expand Up @@ -333,12 +336,13 @@ Utilities

Language detection
==================

.. code-block:: python
nerd.get_language("This is a sentence. This is a second sentence.")
with response
with response:

.. code-block:: python
Expand All @@ -355,12 +359,14 @@ with response
Segmentation
============

.. code-block:: python
nerd.segment("This is a sentence. This is a second sentence.")
with response
with response:

.. code-block:: python
(
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ def my_test_suite():

setup(
name='entity-fishing-client',
version='0.7.3',
version='0.7.2',
description='A minimal client for entity-fishing service.',
long_description=long_description,
long_description_content_type='text/x-rst',
url='https://github.com/Hirmeos/entity-fishing-client-python',
author='Francesco de Virgilio, Luca Foppiano',
author_email='francesco.devirgilio@ubiquitypress.com, luca.foppiano@inria.fr',
Expand Down

0 comments on commit c435de4

Please sign in to comment.