Skip to main content

ASTAligner is designed to align tokens from source code snippets to Abstract Syntax Tree (AST) nodes using Tree-sitter for AST generation and various HuggingFace tokenizers for language tokenization. The library supports a wide range of programming languages and Fast tokenizers, enabling precise mapping between source code elements and their AST representations.

Project description

AST-Alignment Tool

Aligns the tokens from a code snippet to their corresponding nodes in an AST representation.

Description

A Large Language Model (LLM) is a type of AI model designed to understand and generate human-like text based on vast amounts of data. Trained on diverse source code datasets, LLMs can automate Software Engineering tasks across various contexts, such as code translation, code summarization, test-case generation, and code completion. A critical component of LLMs is the tokenizer, which breaks down text into smaller units, typically words or subwords, that the model can process. The tokenizer's role is essential because it converts source code into a format the model can understand, ensuring efficient and accurate code processing and generation. In the context of Interpretability for AI, post-hoc techniques such as ASTScore, rely on alienation functions (phi) to match the tokens generated by an LLM’s tokenizer with their corresponding nodes in the AST representation of a snippet.

Goals

This project has two goals:

(1) Create a library for aligning the tokens from a code snippet to their corresponding nodes in the AST representation

(2) Create a tool to visualize the alignment of the tokens with their matching AST.

Additional Information

For more information regarding this project's background and dependencies, please refer to these readings:

(1) Evaluating and Explaining Large Language Models for Code Using Syntactic Structures

(2) Tree-Sitter Programming Language Parser

(3) Hugging Face Tokenizer

Installation

Use the package manager pip to install all backend dependencies needed for the AST-Alignment Tool. All required packages for the backend can be downloaded using requirements.txt, which can found in the base repository.

pip install -r /path/to/requirements.txt

Supported Features

Library Usage

ASTalign

Using the ASTalign method asks that the user provide:

  • A snippet of code as a string, or a filepath to a text file containing code.
  • The language of the code snippet as one of the following strings:
    • python
    • c
    • cpp
    • csharp
    • java
    • javascript
    • ruby
    • html
    • go
    • kotlin
    • rust
    • haskell
  • A tokenizer specification as one of the following strings:
    • codellama
    • gpt2
    • bert-base-uncased
    • roberta-base
    • dialogpt
    • qwen
  • (Optional) include_whitespace_and_special_tokens flag. Set to False by default, this flag allows the user to specify whether or not to show whitespaces and special characters in the tokens.

The method returns a dictionary of TSTree nodes to a list of tokens from the code snippet that overlap with those nodes. Example usage:

alignments[node] yields [tok1, tok2, ... , tokn]

Contributing

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astaligner-0.7.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ASTAligner-0.7.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file astaligner-0.7.0.tar.gz.

File metadata

  • Download URL: astaligner-0.7.0.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for astaligner-0.7.0.tar.gz
Algorithm Hash digest
SHA256 62a9511a73340ab2d49d83dee8ae4689b4c88ed9d66fb60e0945a9e59cea3c33
MD5 7a07c6da200359127637daa4faa1cea9
BLAKE2b-256 8da5aceef90e9bc852aa21f100204ed99842eb934d6c585720a24b8a9674a655

See more details on using hashes here.

File details

Details for the file ASTAligner-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: ASTAligner-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for ASTAligner-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8bbd5c2cf46d748ebd9a24ca86b9dced908373975cbc68c1a41b039bd399c7
MD5 ef8f764130b278ae52209039d3af1f96
BLAKE2b-256 ca4e6666e4cc1f01a6c310d885c4735ace03a9e48046588bdbe26858fefd5406

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page