himanshu-dutta commited on
Commit
a018049
·
1 Parent(s): 05168af

edited README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -16
README.md CHANGED
@@ -1,53 +1,66 @@
1
- # PyCoder 🐍
 
 
2
 
3
- <img alt="Made With Python" src="http://ForTheBadge.com/images/badges/made-with-python.svg">
4
 
5
- <!-- <img alt="Medium" src="https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white" height=35/> -->
 
6
 
7
- <!-- [![PyPI version fury.io](https://badge.fury.io/py/torchlit.svg)](https://pypi.org/project/torchlit/) -->
 
 
 
8
 
 
 
9
  `PyCoder` is a tool to generate python code out of a few given topics and a description. It uses GPT-2 language model as its engine. Pycoder poses writing Python code as a conditional-Causal Language Modelling(c-CLM). It has been trained on millions of lines of Python code written by all of us. At the current stage and state of training, it produces sensible code with few lines of description, but the scope of improvement for the model is limitless.
10
 
11
  Pycoder has been developed as a Command-Line tool (CLI), an API endpoint, as well as a python package (yet to be deployed to PyPI). This repository acts as a framework for anyone who either wants to try to build Pycoder from scratch or turn Pycoder into maybe a `CPPCoder` or `JSCoder` 😃. A blog post about the development of the project will be released soon.
12
 
13
  To use `Pycoder` as a CLI utility, clone the repository as normal, and install the package with:
14
  ```console
15
- foo@bar:❯ python setup.py install
16
  ```
17
  After this the package could be verified and accessed as either a native CLI tool or a python package with:
18
  ```console
19
  foo@bar:❯ python -m pycoder --version
20
- ```
21
  Or directly as:
22
- ```console
23
  foo@bar:❯ pycoder --version
24
  ```
25
 
 
 
 
 
 
 
26
  The API endpoint is deployed using FastAPI. Once all the requirements have been installed for the project, the API can be accessed with:
27
  ```console
28
  foo@bar:❯ pycoder --endpoint PORT_NUMBER
29
- ```
30
  Or
31
- ```console
32
  foo@bar:❯ pycoder -e PORT_NUMBER
33
  ```
34
-
35
 
36
  ## Tech Stack
37
- <p align="center">
38
  <img alt="Python" src="https://img.shields.io/badge/python-%2314354C.svg?style=for-the-badge&logo=python&logoColor=white" style="display:inline;" />
39
  <img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white" style="display:inline;" />
40
  <img alt="Transformers" src="https://raw.githubusercontent.com/huggingface/transformers/master/docs/source/imgs/transformers_logo_name.png" height=28 width=120 style="display:inline; background-color:white; height:28px; width:120px"/>
41
  <img alt="Docker" src="https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white" style="display:inline;" />
42
  <img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI" height=28 style="display:inline; background-color:black; height:28px;" />
43
  <img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" height=28 style="display:inline; background-color:teal; height:28px;" />
44
- </p>
45
 
46
  ## Tested Platforms
47
- <p align="center">
48
  <img alt="Linux" src="https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black" style="display:inline;" />
49
  <img alt="Windows 10" src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" style="display:inline;" />
50
- </p>
51
 
52
 
53
  ## BibTeX
@@ -63,7 +76,7 @@ If you want to cite the framework feel free to use this:
63
  ```
64
  <hr />
65
 
66
- <p align="center">
67
  <img alt="MIT License" src="https://img.shields.io/github/license/himanshu-dutta/pycoder?style=for-the-badge&logo=appveyor" style="display:inline;" />
68
  <img src="https://img.shields.io/badge/Copyright-Himanshu_Dutta-2ea44f?style=for-the-badge&logo=appveyor" style="display:inline;" />
69
- </p>
 
1
+ <br />
2
+ <div align="center">
3
+ <img src="https://raw.githubusercontent.com/himanshu-dutta/pycoder/master/docs/pycoder-logo-p.png">
4
 
 
5
 
6
+ <br/>
7
+ <img alt="Made With Python" src="http://ForTheBadge.com/images/badges/made-with-python.svg" height=28 style="height:28px;" />
8
 
9
+ <img alt="Medium" src="https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white" height=28 style="height:28px;"/>
10
+
11
+ [![PyPI version fury.io](https://badge.fury.io/py/pycoder.svg)](https://pypi.org/project/pycoder/)
12
+ </div>
13
 
14
+ <div align="justify">
15
+
16
  `PyCoder` is a tool to generate python code out of a few given topics and a description. It uses GPT-2 language model as its engine. Pycoder poses writing Python code as a conditional-Causal Language Modelling(c-CLM). It has been trained on millions of lines of Python code written by all of us. At the current stage and state of training, it produces sensible code with few lines of description, but the scope of improvement for the model is limitless.
17
 
18
  Pycoder has been developed as a Command-Line tool (CLI), an API endpoint, as well as a python package (yet to be deployed to PyPI). This repository acts as a framework for anyone who either wants to try to build Pycoder from scratch or turn Pycoder into maybe a `CPPCoder` or `JSCoder` 😃. A blog post about the development of the project will be released soon.
19
 
20
  To use `Pycoder` as a CLI utility, clone the repository as normal, and install the package with:
21
  ```console
22
+ foo@bar:❯ pip install pycoder
23
  ```
24
  After this the package could be verified and accessed as either a native CLI tool or a python package with:
25
  ```console
26
  foo@bar:❯ python -m pycoder --version
27
+
28
  Or directly as:
29
+
30
  foo@bar:❯ pycoder --version
31
  ```
32
 
33
+ On installation the CLI can be used directly, such as:
34
+
35
+ ```console
36
+ foo@bar:❯ pycoder -t pytorch -t torch -d "a trainer class to train vision model" -ml 120
37
+ ```
38
+
39
  The API endpoint is deployed using FastAPI. Once all the requirements have been installed for the project, the API can be accessed with:
40
  ```console
41
  foo@bar:❯ pycoder --endpoint PORT_NUMBER
42
+
43
  Or
44
+
45
  foo@bar:❯ pycoder -e PORT_NUMBER
46
  ```
47
+ </div>
48
 
49
  ## Tech Stack
50
+ <div align="center">
51
  <img alt="Python" src="https://img.shields.io/badge/python-%2314354C.svg?style=for-the-badge&logo=python&logoColor=white" style="display:inline;" />
52
  <img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white" style="display:inline;" />
53
  <img alt="Transformers" src="https://raw.githubusercontent.com/huggingface/transformers/master/docs/source/imgs/transformers_logo_name.png" height=28 width=120 style="display:inline; background-color:white; height:28px; width:120px"/>
54
  <img alt="Docker" src="https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white" style="display:inline;" />
55
  <img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI" height=28 style="display:inline; background-color:black; height:28px;" />
56
  <img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" height=28 style="display:inline; background-color:teal; height:28px;" />
57
+ </div>
58
 
59
  ## Tested Platforms
60
+ <div align="center">
61
  <img alt="Linux" src="https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black" style="display:inline;" />
62
  <img alt="Windows 10" src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" style="display:inline;" />
63
+ </div>
64
 
65
 
66
  ## BibTeX
 
76
  ```
77
  <hr />
78
 
79
+ <div align="center">
80
  <img alt="MIT License" src="https://img.shields.io/github/license/himanshu-dutta/pycoder?style=for-the-badge&logo=appveyor" style="display:inline;" />
81
  <img src="https://img.shields.io/badge/Copyright-Himanshu_Dutta-2ea44f?style=for-the-badge&logo=appveyor" style="display:inline;" />
82
+ </div>