Skip to content

Latest commit

 

History

History
135 lines (95 loc) · 5.02 KB

README.md

File metadata and controls

135 lines (95 loc) · 5.02 KB
Raw

Code2Parquet

Summary

This code2parquet transform is designed to convert raw particularly ZIP files contain programming files (.py, .c, .java, etc) , into Parquet format. As a transform It is built to handle concurrent processing of Ray-based multiple files using multiprocessing for efficient execution. Each file contained within the ZIP is transformed into a distinct row within the Parquet dataset, adhering to the below schema.

title: (string)

  • Description: Path to the file within the ZIP archive.
  • Example: "title": "data/file.txt"

document: (string)

  • Description: Name of the ZIP file containing the current file.
  • Example: "document": "example.zip"

repo_name:

  • Description: The name of the repository to which the code belongs. This should match the name of the zip file containing the repository.
  • Example: "repo_name": "example"

contents: (string)

  • Description: Content of the file, converted to a string.
  • Example: "contents": "This is the content of the file."

document_id: (string)

  • Description: Unique identifier computed as a uuid.
  • Example: "document_id": "b1e4a879-41c5-4a6d-a4a8-0d7a53ec7e8f"

ext: (string)

  • Description: File extension extracted from the file path.
  • Example: "ext": ".txt"

hash: (string)

  • Description: sha256 hash value computed from the file content string.
  • Example: "hash": "a1b2c3d4"

size: (int64)

  • Description: Size of the file content in bytes.
  • Example: "size": 1024

date_acquired: (string)

  • Description: Timestamp indicating when the file was processed.
  • Example: "date_acquired": "2024-03-25T12:00:00"

snapshot: (string)(optional)

  • Description: Name indicating which dataset it belong to.
  • Example: "snapshot": "github"

programming_language: (string)(optional)

  • Description: Programming language detected using the file extension.
  • Example: "programming_language": "Java"

domain: (string)(optional)

  • Description: Name indicating which domain it belong to, whether code, natural language etc..
  • Example: "domain": "code"

Configuration

The set of dictionary keys holding code2parquet configuration for values are as follows:

The transform can be configured with the following key/value pairs from the configuration dictionary.

  • supported_languages - a dictionary mapping file extensions to language names.
  • supported_langs_file - used if supported_languages key is not provided, and specifies the path to a JSON file containing the mapping of languages to extensions. The json file is expected to contain a dictionary of languages names as keys, with values being a list of strings specifying the associated extensions. As an example, see lang_extensions .
  • data_access_factory - used to create the DataAccess instance used to read the file specified in supported_langs_file.
  • detect_programming_lang - a flag that indicates if the language:extension mappings should be applied in a new column value named programming_language.
  • domain - optional value assigned to the imported data in the 'domain' column.
  • snapshot - optional value assigned to the imported data in the 'snapshot' column.

Running

Launched Command Line Options

When running the transform with the Ray launcher (i.e. TransformLauncher), the following command line arguments are available in addition to the options provided by the launcher.

  • --code2parquet_supported_langs_file - set the supported_langs_file configuration key.
  • --code2parquet_detect_programming_lang - set the detect_programming_lang configuration key.
  • --code2parquet_domain - set the domain configuration key.
  • --code2parquet_snapshot - set the snapshot configuration key.

Running the samples

To run the samples, use the following make targets

  • run-cli-sample - runs src/code2parquet_transform_ray.py using command line args
  • run-local-sample - runs src/code2parquet.py
  • run-s3-sample - runs src/code2parquet.py
    • Requires prior installation of minio, depending on your platform (e.g., from here and here and invocation of make minio-start to load data into local minio for S3 access.

These targets will activate the virtual environment and set up any configuration needed. Use the -n option of make to see the detail of what is done to run the sample.

For example,

make run-cli-sample
...

Then

ls output

To see results of the transform.

Transforming data using the transform image

To use the transform image to transform your data, please refer to the running images quickstart, substituting the name of this transform image and runtime as appropriate.