semvec/pypi-packages huggingface dataset:
code-sodium 0.0.0.post0
the package of neural networks and utilities
Requires Python: >=3
Keywords: sodium

<div align="center">
  <img src="https://raw.githubusercontent.com/YeongHyeon/sodium/7253890a6f7638a750e36a069c03b37d95019887/misc/code-sodium.svg?token=AFJZUXAFEDXUMUWZ2Z5TJJTCGHNTC" width="200">
</div>  

---
<strong>code-sodium</strong> (short for <a href="https://github.com/YeongHyeon/sodium">sodium</a>) is a Python module for deep learning built on top of TensorFlow and is distributed under the MIT license.  

The project was started in March 2022 by <a href="https://github.com/YeongHyeon">YeongHyeon Park</a>.  
This project does not limit for participation.  
Contribute now!  

## Installation

### Dependencies
sodium requires:
* Numpy: 1.19.5  
* TensorFlow: 2.4.0  

### User installation
You can install the sodium via simple command as below.  
``` sh
$ pip install code-sodium
```

## Development
There is no limit for new contributors of all experience levels. The sodium community goals are to be helpful, welcoming, and effective. The Development Guide has detailed information about contributing code, documentation, tests, and more. We've included some basic information in this README.

## Example

#### Import sodium package
``` python
import sodium
```
masakhane 0.0.3
An effective language-first preprocessing tool for African languages (🔧 Beta version).
Requires Python: >=3.6

# `masakhane-preprocessor` 
An effective language-first preprocessing tool for African languages (🔧 Beta version).

We build on the [clean-text](https://github.com/jfilter/clean-text/tree/master/cleantext) preprocessor.

## How to Use
Install:
```pip install masakhane-preprocessor```
## Preprocessor
You only need to specify your language and it loads the important preprocessing style for You!

You initialize the `Preprocessor` in Python as follows:
```python
from masakhane-preprocessor import Preprocessor

my_prep = Preprocessor(lang='ig')
```

You can also directly include some additional parameters you want:
```python
my_prep = Preprocessor(lang='ig',
              lower=True,
              strip_punctuation=True,
              strip_symbols=True)
```
### preproces_str
To preprocess a string use the `preproces_str` function:
```python
clean_text = my_prep.preprocess_str('''Dịka● ndọrọndọrọọchịchị maka ntuliaka ọkwa Gọvanọ
                                       Anambra steeti si na-aga nke afọ 2021, ndị nọ.''')
```
You get the following as output:
```Dịka ndọrọndọrọọchịchị maka ntuliaka ọkwa Gọvanọ Anambra steeti si na-aga nke afọ 2021 ndị nọ```

> Notice how the `●` character has been removed, but the `-`, which is an important part of Igbo, remains untouched.


### preprocess_file
To preprocess a file use the `preprocess_file` function:
```python
my_prep.preprocess_file('ig.txt',
                        output_path=None #Specify the output path. If unspecified, uses the parent directory of input file)
```
On successful completion you get this message:
`Clean file(s) saved successfully to xxxxxxx/ig_CLEAN.txt`

### Properties of the preprocessing tool
1. Language-first
    It can:
    - map any African language name provided to its language code. You can write `Preprocessor(lang='yoruba')` using just the name. 
    - map any language code to its BCP47 variant. So even if you use `yo` or `yor` it does not matter.

2. Simple to use

## Contribution
We are open to and grateful for ideas to make this better. You can propose ideas as issues or pull requests.

---

<h3 align="center">
    With 💙 From <a href="https://github.com/masakhane-io/masakhane-preprocessing/graphs/contributors" target="_blank">The Contributors</a>
</h3>
masakhane-preprocessor 0.0.2
An effective language-first preprocessing tool for African languages (🔧 Beta version).
Requires Python: >=3.6

# `masakhane-preprocessor` 
An effective language-first preprocessing tool for African languages (🔧 Beta version).

We build on the [clean-text](https://github.com/jfilter/clean-text/tree/master/cleantext) preprocessor.

## How to Use
Install:
```pip install masakhane-preprocessor```
## Preprocessor
You only need to specify your language and it loads the important preprocessing style for You!

You initialize the `Preprocessor` in Python as follows:
```python
from masakhane-preprocessor import Preprocessor

my_prep = Preprocessor(lang='ig')
```

You can also directly include some additional parameters you want:
```python
my_prep = Preprocessor(lang='ig',
              lower=True,
              strip_punctuation=True,
              strip_symbols=True)
```
### preproces_str
To preprocess a string use the `preproces_str` function:
```python
clean_text = my_prep.preprocess_str('''Dịka● ndọrọndọrọọchịchị maka ntuliaka ọkwa Gọvanọ
                                       Anambra steeti si na-aga nke afọ 2021, ndị nọ.''')
```
You get the following as output:
```Dịka ndọrọndọrọọchịchị maka ntuliaka ọkwa Gọvanọ Anambra steeti si na-aga nke afọ 2021 ndị nọ```

> Notice how the `●` character has been removed, but the `-`, which is an important part of Igbo, remains untouched.


### preprocess_file
To preprocess a file use the `preprocess_file` function:
```python
my_prep.preprocess_file('ig.txt',
                        output_path=None #Specify the output path. If unspecified, uses the parent directory of input file)
```
On successful completion you get this message:
`Clean file(s) saved successfully to xxxxxxx/ig_CLEAN.txt`

### Properties of the preprocessing tool
1. Language-first
    It can:
    - map any African language name provided to its language code. You can write `Preprocessor(lang='yoruba')` using just the name. 
    - map any language code to its BCP47 variant. So even if you use `yo` or `yor` it does not matter.

2. Simple to use

## Contribution
We are open to and grateful for ideas to make this better. You can propose ideas as issues or pull requests.

---

<h3 align="center">
    With 💙 From <a href="https://github.com/masakhane-io/masakhane-preprocessing/graphs/contributors" target="_blank">The Contributors</a>
</h3>