Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 3.25 KB

README.md

File metadata and controls

96 lines (58 loc) · 3.25 KB

Notebooks

Table of contents

Requirements

The below are required in order to be able to amend the notebooks and update the repo:

  • jupyter (notebook or labs)
  • nbdime plugin for jupyter (notebook or labs): helps with comparing and viewing git related changes
  • install pre-commit in the root of the project folder: pip install pre-commit
  • enable pre-commit in the root of the project folder: pre-commit install

You can also run pre-commit manually by doing the below:

pre-commit run --all

(This is automatically run in the CI/CD when commits are pushed and/or pull request is created on the repo).

Download the notebooks

Go to https://github.com/neomatrix369/nlp_profiler/releases and select the latest release for e.g. https://github.com/neomatrix369/nlp_profiler/releases/tag/v0.0.3 and then download the notebooks archive (v0.0.3) attached to the release.

The archive should contain .ipynb files.

How to run the notebooks?

In order to run the notebooks:

  • Unzip the archive in the current folder
  • Then run jupyter by doing the following:
$ jupyter labs .

or

$ jupyter notebook .

How to update the notebooks?

  • In case you wish to add new changes to the notebook, feel free to do so but do note the release/package version for which you are making these changes
  • Zip them up and create pull request with the changes in the zipped archive
  • Ensure you have done all the testing and checking
  • Please maintain the same formatting as in the original notebooks

Why this method? We are not adding .ipynb files to this repo as it makes GitHub think the repo is a Jupyter notebook repo and not a python language repo.

Jupyter and Google Colab

The notebooks can be opened in both Jupyter and Google Colab, here is a sample view of what one of the notebook looks like:

Kaggle kernels

Notebook/Kernel | Script | Other related links

Screenshots

Importing the library

Pandas describe() function

Developer guide

See Developer guide to know how to build, test, and contribute to the library.

Contributing

Contributions are Welcome!

Please have a look at the CONTRIBUTING guidelines.

Please share it with the wider community (and get credited for it)!

Go to the Main page