NeoDiscoveryAdmin commited on
Commit
e67193a
·
1 Parent(s): 14733c0

add 1st model card description and necessary files for following updates

Browse files
README.md CHANGED
@@ -1,3 +1,51 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+ # TabM Model Instructions
5
+
6
+ ## Model Overview
7
+
8
+ ### 1.1 Method Description
9
+ This implementation utilizes the approach from the research paper:
10
+ **"TabM: Advancing Tabular Deep Learning With Parameter-Efficient Ensembling" (ICLR 2025)**
11
+
12
+ - **Paper Link**: https://arxiv.org/abs/2410.24210
13
+ - **Original Repository**: https://github.com/yandex-research/tabm
14
+
15
+ ### 1.2 Motivation
16
+ Compared to traditional machine learning methods used in NeoRanking, we aim to explore the performance of Tabular Deep Learning approaches on this type of data for classification tasks.
17
+
18
+ ## Training Details
19
+
20
+ ### 2.1 Training Data
21
+ The detailed training dataset is located at: `data/tabm_train.tsv`
22
+
23
+ ### 2.2 Training Parameters
24
+ - Model parameters were optimized using the `hyper` framework for parameter tuning
25
+ - Training script: `src/tabm_train.py`
26
+ - Testing script: `src/tabm_test.py`
27
+
28
+ ### 2.3 Testing Data
29
+ - Test dataset: `data/tabm_test.tsv`
30
+ - Evaluation metrics have been updated in `spaces/leaderboard`
31
+
32
+ ## Model Usage
33
+
34
+ ### 3.1 Installation
35
+ ```bash
36
+ pip3 install tabm
37
+ ```
38
+
39
+ ### 3.2 Training
40
+ ```bash
41
+ bash scripts/tabm_train.sh
42
+ ```
43
+
44
+ ### 3.3 Testing
45
+ ```bash
46
+ bash scripts/tabm_test.sh
47
+ ```
48
+
49
+ ## Special Notes
50
+
51
+ Our use of TabM fully complies with the **Apache-2.0 license**. If you need to reference or reuse this model, please adhere to the original author's citation requirements and properly attribute the source.
data/tabm_test.tsv ADDED
File without changes
data/tabm_train.tsv ADDED
File without changes
scripts/tabm_test.sh ADDED
File without changes
scripts/tabm_train.sh ADDED
File without changes
src/tabm.py ADDED
File without changes