Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b028f0e

Browse files
Update README.md
1 parent aa6bddd commit b028f0e

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

‎README.md‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,46 @@ codeBERT is a package to **automatically review you code documentation**. codeBE
55
*code-bert present version is available for Linux and Mac only. We are working on the Windows release. Please hang on*
66

77

8-
🔨 Given a function body `f` as a string of code tokens (including special tokens such as `indent` and `dedent`) and a doc string `d` as a string of Natual Language tokens. Predict whether `f` and `d` are assciated or not (meaning, whether they represent the same concept or not)
9-
108
This is [CodistAI](https://codist-ai.com/) open source version to easily use the fine tuned model based on our open source MLM code model [codeBERT-small-v2](https://huggingface.co/codistai/codeBERT-small-v2)
119

1210
[codeBERT-small-v2](https://huggingface.co/codistai/codeBERT-small-v2) is a RoBERTa model, trained using Hugging Face Transformer library and then we have fine tuned the model on the task of predicting the following -
1311

1412

13+
## 🏆 code-bert output
14+
15+
Given a function body `f` as a string of code tokens (including special tokens such as `indent` and `dedent`) and a doc string `d` as a string of Natual Language tokens. Predict whether `f` and `d` are assciated or not (meaning, whether they represent the same concept or not)
16+
17+
18+
It will produce a report like the following -
19+
20+
`run_pipeline -r test_files`
21+
22+
```
23+
======== Analysing test_files/test_code_add.py =========
24+
25+
Function "add" with Docstring """sums two numbers and returns the result"""
26+
Do they match?
27+
Yes
28+
```
29+
30+
```
31+
======== Analysing test_files/test_code_add.py =========
32+
33+
Function "return_all_even" with Docstring """numbers that are not really odd"""
34+
Do they match?
35+
Yes
36+
37+
```
38+
39+
```
40+
======== Analysing test_files/inner_dir/test_code_get.py =========
41+
42+
Function "get_file" with Docstring """opens a url"""
43+
Do they match?
44+
No
45+
46+
```
47+
1548

1649
## An example
1750

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /