rimoKR's picture
Update README.md
775999d verified
metadata
library_name: transformers
tags:
  - github
datasets:
  - lewtun/github-issues
language:
  - en
base_model:
  - google-bert/bert-base-uncased

Model Card for Model ID

This is a fine-tuned bert-base-uncased model for multi-label classification of GitHub issues into various tags (e.g., bug, enhancement, documentation, etc.).

Model Details

  • Base model: bert-base-uncased
  • Task: Multi-label Text Classification
  • Labels: 19 possible tags (e.g., bug, dataset request, help wanted, etc.)
  • Tokenizer: bert-base-uncased

Model Description

This model performs multi-label classification of GitHub issues based on their content. Each issue is represented by a combination of its title, body, state, and associated comments. These components are concatenated into a single input string using the following format:

  if example.get("title"):
          text_parts.append("Title: " + example["title"])
      if example.get("body"):
          text_parts.append("Body: " + example["body"])
      if example.get("state"):
          text_parts.append("State: " + example["state"])
  
      comments = example.get("comments", [])
      if comments:
          text_parts.append("Comments: " + " ".join(comments))
  
      return {"text": " \n ".join(text_parts)}

The resulting "text" field serves as the input to the model. Each text entry is tokenized using the Hugging Face bert-base-uncased tokenizer with the following configuration:

  tokenizer(
        example["text"],
        padding="max_length",
        truncation=True,
        max_length=512
  )

The target labels are constructed as a binary vector of length 19, where each element corresponds to one of the predefined GitHub issue tags (e.g., bug, enhancement, documentation, etc.). Each element in the vector is set to 1 if the tag is present for the issue, and 0 otherwise. This format enables the model to perform multi-label classification, allowing it to assign multiple relevant tags to a single GitHub issue.

Model Sources [optional]

  • Repository: [More Information Needed]
  • Paper [optional]: [More Information Needed]
  • Demo [optional]: [More Information Needed]

Uses

Direct Use

[More Information Needed]

Downstream Use [optional]

[More Information Needed]

Out-of-Scope Use

[More Information Needed]

Bias, Risks, and Limitations

[More Information Needed]

Recommendations

Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.

How to Get Started with the Model

Use the code below to get started with the model.

[More Information Needed]

Training Details

Training Data

[More Information Needed]

Training Procedure

Preprocessing [optional]

[More Information Needed]

Training Hyperparameters

  • Training regime: [More Information Needed]

Speeds, Sizes, Times [optional]

[More Information Needed]

Evaluation

Testing Data, Factors & Metrics

Testing Data

[More Information Needed]

Factors

[More Information Needed]

Metrics

[More Information Needed]

Results

[More Information Needed]

Summary

Model Examination [optional]

[More Information Needed]

Environmental Impact

Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).

  • Hardware Type: [More Information Needed]
  • Hours used: [More Information Needed]
  • Cloud Provider: [More Information Needed]
  • Compute Region: [More Information Needed]
  • Carbon Emitted: [More Information Needed]

Technical Specifications [optional]

Model Architecture and Objective

[More Information Needed]

Compute Infrastructure

[More Information Needed]

Hardware

[More Information Needed]

Software

[More Information Needed]

Citation [optional]

BibTeX:

[More Information Needed]

APA:

[More Information Needed]

Glossary [optional]

[More Information Needed]

More Information [optional]

[More Information Needed]

Model Card Authors [optional]

[More Information Needed]

Model Card Contact

[More Information Needed]