.. SkillNer documentation master file, created by
   sphinx-quickstart on Wed Oct 13 18:07:05 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to SkillNer's documentation!
====================================

SkillNer is an NLP package that leverage **Named Entity Recognition** (NER) to automatically extract 
skills and certifications from job postings and applicants' resumes.


At the core, SkillNer is a skill extractor. Yet, it unlocks tons of features, 
e.g. helps both recruiters to find the best matches for their needs and applicants learn more about the job market.


Not convinced yet? Let's :ref:`Get started <getting started>`!


Team
----
We started small with a team of two members, `Anas AIT AOMAR`_ and `Badr MOUFAD`_ . 
Yet, with **SkillNer** being open
sourced, the team will surely get bigger and bigger.

.. _Anas AIT AOMAR: https://github.com/AnasAito
.. _Badr MOUFAD: https://github.com/Badr-MOUFAD



.. toctree::
   :maxdepth: 2
   :caption: Contents:


Table of contents
-----------------

.. toctree::
   get_started
   tutorials
   api_refs
   low_api_refs
   contribute