pelican-nlp 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

pelican_nlp/__init__.py

@@ -1,5 +1,5 @@
 # Version and metadata
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 __author__ = "Yves Pauli"
 
 try:

{pelican_nlp-0.1.0.dist-info → pelican_nlp-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.1.0
+Version: 0.1.1
 Summary: Preprocessing and Extraction of Linguistic Information for Computational Analysis
 Author-email: Yves Pauli <yves.pauli@gmail.com>
 License-Expression: CC-BY-NC-4.0
@@ -51,7 +51,7 @@ PELICAN_nlp
 PELICAN_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
 
 .. image:: https://img.shields.io/pypi/v/package-name.svg
-    :target: https://pypi.org/project/package-name/
+    :target: https://pypi.org/project/pelican-nlp/
     :alt: PyPI version
 
 .. image:: https://img.shields.io/github/license/username/package-name.svg
@@ -59,7 +59,7 @@ PELICAN_nlp stands for "Preprocessing and Extraction of Linguistic Information f
     :alt: License
 
 .. image:: https://img.shields.io/pypi/pyversions/package-name.svg
-    :target: https://pypi.org/project/package-name/
+    :target: https://pypi.org/project/pelican-nlp/
     :alt: Supported Python Versions
 
 Installation
@@ -82,6 +82,9 @@ Usage
 
 To use the pelican_nlp package:
 
+Adapt your configuration file to your needs.
+ALWAYS change the specified project folder location.
+
 .. code-block:: python
 
     from pelican_nlp.main import Pelican
@@ -94,7 +97,7 @@ For reliable operation, data must be stored in the *Language Processing Data Str
 
 Text and audio files should follow this naming convention:
 
-subjectID_sessionID_task_task-supplement_corpus.extension
+[subjectID]_[sessionID]_[task]_[task-supplement]_[corpus].[extension]
 
 - subjectID: ID of subject (e.g., sub-01), mandatory
 - sessionID: ID of session (e.g., ses-01), if available
@@ -121,26 +124,15 @@ Features
 Examples
 ========
 
-Here's a detailed usage example:
-
-.. code-block:: python
-
-    from package_name import SomeClass
-
-    configuration_file = "config_fluency.yml"
-    pelican.run(configuration_file)
-
-*Link to config_fluency.yml*
-
-Sample folder for data collection of the semantic fluency task:
-*Link to sample_folder*
+You can find example setups in the [`examples/`](https://github.com/ypauli/PELICAN-nlp/examples) folder.
+ALWAYS change the path to the project folder specified in the configuration file to your specific project location.
 
 Contributing
 ============
 
-Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/PELICAN/blob/main/CONTRIBUTING.md>`_.
+Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/PELICAN-nlp/blob/main/CONTRIBUTING.md>`_.
 
 License
 =======
 
-This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/PELICAN/blob/main/LICENSE>`_ file for details.
+This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE>`_ file for details.

{pelican_nlp-0.1.0.dist-info → pelican_nlp-0.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pelican_nlp/__init__.py,sha256=yLyG5Amt7nuHQMHz0tuGUVsGBtgVmXT0LMeRo3an-OU,192
+pelican_nlp/__init__.py,sha256=opumkxDDKxGZgYyNkkUiu8kbOrBixP8zP_bhljYYktc,192
 pelican_nlp/main.py,sha256=xKUqqA3sh9kbk07lKA_poILIU1c8oIeaSsVqPOPY5Tk,7596
 pelican_nlp/core/__init__.py,sha256=whJc5dWsGsKn2IAw-D4BvCvUKW1sVtWYE1WJIuUr5uI,165
 pelican_nlp/core/audio_document.py,sha256=hhSJNgeqSYa6_uws2ho66agHhAdHuKN3EIEdIsIcXKg,586
@@ -32,8 +32,8 @@ pelican_nlp/utils/__init__.py,sha256=q1tGdOOj5UPRC2mGhoMUh8p4cbFCkkbD21bQaOVvFao
 pelican_nlp/utils/csv_functions.py,sha256=hsG73gm3Up9sAerp6gIxuNHaeP1vJj6HSh7ggVm1SSo,7272
 pelican_nlp/utils/sample_usage.py,sha256=W__OVMjWND-ZtxxRhfGJDHwbVpGlB-anXDxyA5P4cME,353
 pelican_nlp/utils/setup_functions.py,sha256=s0QcarswU8qeFBcEQNIYC1ooaD-xwRiTJn--yPEId8E,3612
-pelican_nlp-0.1.0.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
-pelican_nlp-0.1.0.dist-info/METADATA,sha256=kIWgpFUOeQC1c-DYvSPoN82OXBgV7TJtPLUGLNC5KDs,4947
-pelican_nlp-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pelican_nlp-0.1.0.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
-pelican_nlp-0.1.0.dist-info/RECORD,,
+pelican_nlp-0.1.1.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
+pelican_nlp-0.1.1.dist-info/METADATA,sha256=WV78gC4295adtWepMzCQm1yCkUa1LIBm9vkz9YFx3Dk,4986
+pelican_nlp-0.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pelican_nlp-0.1.1.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
+pelican_nlp-0.1.1.dist-info/RECORD,,