Update README.md
Browse files
README.md
CHANGED
@@ -67,40 +67,11 @@ Static network visualization focusing on model relationships and similarity patt
|
|
67 |
- Spot potential consolidation opportunities
|
68 |
- Explore the current modular architecture
|
69 |
|
70 |
-
## 🛠️ Technical Details
|
71 |
-
|
72 |
-
### Similarity Methods
|
73 |
-
- **Jaccard Similarity**: Token-based similarity using identifier overlap in source code
|
74 |
-
- **Embedding Similarity**: CodeBERT-based semantic similarity (when available)
|
75 |
-
|
76 |
-
### Data Sources
|
77 |
-
- **Git History**: Model creation dates from transformers repository commits
|
78 |
-
- **Source Analysis**: AST parsing of `modeling_*.py` and `modular_*.py` files
|
79 |
-
- **Dependency Tracking**: Import analysis to build modular dependency graphs
|
80 |
-
- **Cached Embeddings**: Pre-computed similarity matrices for performance
|
81 |
-
|
82 |
### Filtering Options
|
83 |
- **Similarity Threshold**: Adjustable cutoff for showing similarity edges (0.5-0.95)
|
84 |
- **Multimodal Filter**: Focus on models with multimodal capabilities (models mentioning "pixel_values")
|
85 |
- **Show/Hide Candidates**: Toggle visibility of non-modular models and their similarities
|
86 |
|
87 |
-
## 🎯 Use Cases
|
88 |
-
|
89 |
-
1. **Refactoring Planning**: Identify which models would benefit most from modularization
|
90 |
-
2. **Architecture Analysis**: Understand current modular dependencies and patterns
|
91 |
-
3. **Code Reduction**: Quantify the impact of modular refactoring on maintainability
|
92 |
-
4. **Timeline Analysis**: See how the transformers library evolved toward modular architecture
|
93 |
-
|
94 |
-
## 📚 How to Use
|
95 |
-
|
96 |
-
1. **Chronological Timeline**: Use the search box to find specific models, zoom to explore different time periods, click nodes to highlight connections
|
97 |
-
2. **LOC Growth**: Hover over data points to see exact metrics, observe the trend toward code reduction
|
98 |
-
3. **Dependency Graph**: Drag nodes to reorganize the layout, toggle candidates on/off, use zoom for detailed exploration
|
99 |
-
|
100 |
-
## 🔬 Research Context
|
101 |
-
|
102 |
-
This tool supports analysis of modular refactoring in large-scale ML libraries, helping identify code duplication patterns and measure the effectiveness of architectural improvements in reducing maintenance burden.
|
103 |
-
|
104 |
---
|
105 |
|
106 |
*Built with Gradio, D3.js, and ApexCharts for interactive data visualization*
|
|
|
67 |
- Spot potential consolidation opportunities
|
68 |
- Explore the current modular architecture
|
69 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
70 |
### Filtering Options
|
71 |
- **Similarity Threshold**: Adjustable cutoff for showing similarity edges (0.5-0.95)
|
72 |
- **Multimodal Filter**: Focus on models with multimodal capabilities (models mentioning "pixel_values")
|
73 |
- **Show/Hide Candidates**: Toggle visibility of non-modular models and their similarities
|
74 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
75 |
---
|
76 |
|
77 |
*Built with Gradio, D3.js, and ApexCharts for interactive data visualization*
|