Skip to content

Commit

Permalink
Revert "Update ReadMe file"
Browse files Browse the repository at this point in the history
This reverts commit 98ceb39.
  • Loading branch information
vmdiwanji committed Mar 4, 2020
1 parent 98ceb39 commit 67f2576
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@ Installation Instructions -

`pip3 install -r requirements.txt`

Configuration:

Create a config.json file using the sample file in the repository.

Path to the corresponding Model files are provided as shown in the sample config file.
Command Line Interface -

Optional Authentication:
createJSON.py generates a JSON object after extracting useful information from the github repository. It classifies the readme file into one of four categories - description, invocation, installation, citation depending on highest confidence above a given threshold.

Add the following line to the config.json to add Authentication for requests to github repository:
The createJSON.py file takes as input the following parameters:

`"Authentication": "token PersonalAccessToken"`
-r / --repo_url: Link to the github repository for extracting information

Information on generating Personal Access Token - https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
-m / --model_path: Path to the pickled models for extraction

-o / --output: Output file name

-t / --threshold: Threshold to classify the content of the readme file

-d / --doc_src: Path of documentation file

Command Line Interface -

cli.py generates a JSON object after extracting useful information from the github repository. It classifies the readme file into one of four categories - description, invocation, installation, citation depending on confidence above a given threshold.

Expand All @@ -33,11 +36,8 @@ The cli.py file takes as input the following parameters:

-d / --doc_src: Path of documentation file

Add/Remove a Category:

If user wants to run the classifier for an additional category or wants to remove an existing category, corresponding path entry in the config.json should be provided and the category type should be added in the category variable in the cli.py


Example:

`python3 createJSON.py -r https://github.com/{owner}/{repository_name} -m ./models/ -o output.json -t 0.5`

`python3 cli.py -r https://github.com/{owner}/{repository_name} -o output.json -t 0.5`

0 comments on commit 67f2576

Please sign in to comment.