Update README.md

README.md

@@ -1,199 +1,159 @@
----
-library_name: transformers
-tags: []
----
-
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+# 🔍 Obfuscated Variable Renaming with aixcoder
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+This repository hosts a **aixcoder–based model** fine-tuned to **rename obfuscated variables in source code**, improving readability while preserving program semantics.
 
-## How to Get Started with the Model
+The model is designed for use cases such as **malware analysis, reverse engineering, digital forensics, and general program comprehension**.
 
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
+---
 
-<!-- This should link to a Dataset Card if possible. -->
+## 🚀 Task Overview
 
-[More Information Needed]
+**Task:** Code Deobfuscation / Variable Renaming  
+**Base Model:** Qwen-Code  
+**Input:** Source code with obfuscated variable names  
+**Output:** Semantically equivalent source code with readable variable names  
 
-#### Factors
+### Example
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+**Input**
+```javascript
+function _0x12af(a, b) {
+  let _0x9c3e = a * b;
+  return _0x9c3e + 10;
+}
+```
 
-[More Information Needed]
+**Output**
+```javascript
+function multiplyAndAdd(a, b) {
+  let product = a * b;
+  return product + 10;
+}
+```
 
-#### Metrics
+---
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+## 🧠 Model Description
 
-[More Information Needed]
+- **Architecture:** aixcoder (Transformer-based)
+- **Fine-tuning Objective:** Context-aware variable renaming
+- **Approach:** AST-guided identifier alignment + sequence generation
+- **Languages:** JavaScript (primary), extendable to others
 
-### Results
+The model learns to infer meaningful variable names from **usage context**, not from superficial patterns.
 
-[More Information Needed]
+---
 
-#### Summary
+## 🏗 Training Details
 
+### Dataset
+- Paired samples of:
+  - Obfuscated code
+  - Original / readable code
+- Variable mappings extracted using **AST-based analysis**
+- Realistic obfuscation patterns (minifiers, packers, name mangling)
 
+### Training Objectives
+- Identifier-aware sequence-to-sequence learning
+- Contextual name prediction
+- Syntax preservation
 
-## Model Examination [optional]
+---
 
-<!-- Relevant interpretability work for the model goes here -->
+## 📦 Installation
 
-[More Information Needed]
+```bash
+pip install transformers torch accelerate
+```
 
-## Environmental Impact
+---
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+## ▶️ Usage
 
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+### Inference Example
 
-- **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]
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-## Technical Specifications [optional]
+model_id = "Neo111x/aixcoder-renaming"
 
-### Model Architecture and Objective
+tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    device_map="auto",
+    trust_remote_code=True
+)
 
-[More Information Needed]
+code = '''
+function _0x12af(a, b) {
+  let _0x9c3e = a * b;
+  return _0x9c3e + 10;
+}
+'''
 
-### Compute Infrastructure
+inputs = tokenizer(code, return_tensors="pt")
+outputs = model.generate(
+    **inputs,
+    max_new_tokens=1024,
+    do_sample=False
+)
 
-[More Information Needed]
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
 
-#### Hardware
+---
 
-[More Information Needed]
+## 🧪 Evaluation
 
-#### Software
+- Identifier exact-match accuracy
+- AST equivalence checks
+- Manual readability assessment
 
-[More Information Needed]
+---
 
-## Citation [optional]
+## ⚠️ Limitations
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+- Generated names are **semantic approximations**, not original identifiers
+- Performance degrades on:
+  - Extremely short contexts
+  - Heavy control-flow flattening
+- Single-file scope only
 
-**BibTeX:**
+---
 
-[More Information Needed]
+## 🔐 Ethical Considerations
 
-**APA:**
+This model is intended for:
+- Malware and binary analysis
+- Digital forensics and incident response (DFIR)
+- Code maintenance and auditing
 
-[More Information Needed]
+It should **not** be used to violate software licenses or intellectual property rights.
 
-## Glossary [optional]
+---
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## 🧩 Future Work
 
-[More Information Needed]
+- Multi-language support (C/C++, Python)
+- Function and class renaming
+- Control-flow–aware modeling
+- Integration with decompilers and IR tools
 
-## More Information [optional]
+---
 
-[More Information Needed]
+## 📜 License
 
-## Model Card Authors [optional]
+Specify the license here (e.g., Apache-2.0, MIT).
 
-[More Information Needed]
+---
 
-## Model Card Contact
+## 📖 Citation
 
-[More Information Needed]
+```bibtex
+@misc{qwen_code_variable_renamer,
+  title={Context-Aware Variable Renaming for Obfuscated Code using Qwen-Code},
+  author={Your Name},
+  year={2026},
+  url={https://huggingface.co/Neo111x/aixcoder-renaming}
+}
+```