Table of contents

1. Notice
2. How to install Vujade for Python
3. How to add project path to the PYTHONPATH
4. How to remove ^M characters
5. License
6. Todo
7. Reference

1. Notice

• A collection of useful classes and functions based on the Python3 for deep learning research and development
  • The vujade consists of useful codes that I coded myself, wrapper classes and wrapper functions for the Python3 package.
  • Once you're comfortable with vujade, you don't need to search the internet to see how to use functions and classes.
• I recommend that you should ignore the commented instructions with an octothorpe, #.

2. How to install Vujade for Python

• Please note that some Python3 packages should be required. You can install the rquired packages using Python3 official package manager, pip3.
• Please note that the pip3 based vujade has not fully supported all features yet.

1. How to install vujade using pip3 from the PyPI

$ pip3 install vujade

2. How to install vujade using pip3 from the GitHub repository

$ pip3 install git+https://github.com/vujadeyoon/vujade-python@${name_tag}

3. How to install vujade using pip3 from local repository

$ pip3 install -e .

4. How to merge vujade

$ git clone https://github.com/vujadeyoon/vujade-python vujade-python
$ cd ./vujade-python/ && bash ./script/bash_setup_vujade.sh && cd ../

3. How to add project path to the PYTHONPATH

If some errors occur for the vujade path in the project, I recommend you should add the project path to the PYTHONPATH.

$ export PYTHONPATH=$PYTHONPATH:$(pwd)

4. How to remove ^M characters

1. dos2unix

$ dos2unix ${PATH_FILE}

2. Sed

$ sed 's/^M//g' ${PATH_FILE}

5. License

• I respect and follow the license of the used libraries including python3 packages.
• The libraries including python3 packages are licensed by their licenses.
• Please note that the only providen vujadeyoon's own codes and wrapper-codes comply with the MIT license.

6. Todo

• Instructions for usage will be updated in the future.

7. Reference

1. remove ^M characters from file using sed