code-summarisation

Code Summarization and Documentation

Coding LLMs can automatically generate summaries and documentation for code repositories, modules, or functions. By extracting key insights and explanations from source code, these models facilitate code understanding, collaboration, and knowledge sharing among developers.

Code Summarization Workflow

This workflow help to concise summaries or documentation for code snippets, making it easier for developers to understand and maintain complex codebases.

Model used

This workflow uses the gpt-4-turbo Model with defined prompt template optimized for code Summarization.

How to use the Code Summarization workflow? 

Using Clarifai SDK

Export your PAT as an environment variable. Then, import and initialize the API Client.

Find your PAT in your security settings.

export CLARIFAI_PAT={your personal access token}

Prediction with the workflow

from clarifai.client.workflow import Workflow

workflow_url = 'https://clarifai.com/{{user_id}}/coding-template/workflows/code-summarisation'

text = '
merge_sort(arr):
if len(arr) <= 1: return arr mid=len(arr) // 2 left=merge_sort(arr[:mid]) right=merge_sort(arr[mid:]) return merge(left, right) def merge(left, right): result=[] while left and right: if left[0] < right[0]: result.append(left.pop(0)) else: result.append(right.pop(0)) '

prediction = Workflow(workflow_url).predict_by_bytes( text.encode(), input_type="text")

# Get workflow results
print(prediction.results[0].outputs[-1].data.text.raw)

Using Workflow

To utilize the Code Completion workflow, you can input your code snippet through the Blue Plus Try your own Input button and it will output concise summaries or documentation for code snippets.