Skip to content

Commit 2acc87a

Browse files
committed
Added Credits
1 parent e81e3c3 commit 2acc87a

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ import textpredict as tp
5555

5656
model = tp.initialize(task="sentiment")
5757
result = model.analyze(text = ["I love this product!", "I hate this product!"], return_probs=False)
58-
print(f"Sentiment Prediction Result: {result}")
5958
```
6059

6160
### Using Pre-trained Models from Hugging Face
@@ -65,7 +64,6 @@ Utilize a specific pre-trained model from Hugging Face:
6564
```python
6665
model = tp.initialize(task="emotion", model_name="AnkitAI/reviews-roberta-base-sentiment-analysis", source="huggingface")
6766
result = model.analyze(text = "I love this product!", return_probs=True)
68-
print(f"Sentiment Prediction Result: {result}")
6967
```
7068

7169
### Using Models from Local Directory
@@ -75,7 +73,6 @@ Load and use a model from a local directory:
7573
```python
7674
model = tp.initialize(task="ner", model_name="./results", source="local")
7775
result = model.analyze(text="I love this product!", return_probs=True)
78-
print(f"Sentiment Prediction Result: {result}")
7976
```
8077

8178
### Training a Model
@@ -97,7 +94,6 @@ trainer.train()
9794
# Save and evaluate the trained model
9895
trainer.save()
9996
metrics = trainer.evaluate(test_dataset=val_data)
100-
print(f"Evaluation Metrics: {metrics}")
10197
```
10298

10399
For detailed examples, refer to the `examples` directory.
@@ -110,12 +106,11 @@ Understand model predictions with feature importance:
110106
text = "I love this product!"
111107
explainer = tp.Explainability(model_name="bert-base-uncased", task="sentiment", device="cpu")
112108
importance = explainer.feature_importance(text=text)
113-
print(f"Feature Importance: {importance}")
114109
```
115110

116111
## Documentation
117112

118-
For detailed documentation, please refer to the [TextPredict Documentation](#).
113+
For detailed documentation, please refer to the [TextPredict Documentation](https://ankit-aglawe.github.io/textpredict/).
119114

120115
## Contributing
121116

@@ -125,6 +120,11 @@ Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTIN
125120

126121
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
127122

123+
## Credits
124+
125+
This project leverages the [Transformers](https://github.com/huggingface/transformers) library by Hugging Face. We extend our gratitude to the Hugging Face team and to the developers, contributors for their work for their work in creating and maintaining such a valuable resource for the NLP community.
126+
127+
128128
### Links
129129

130130
- **GitHub Repository**: [Github](https://github.com/ankit-aglawe/textpredict)
@@ -133,3 +133,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
133133
- **Source Code**: [Source Code](https://github.com/ankit-aglawe/sentimentpredictor)
134134
- **Issue Tracker**: [Issue Tracker](https://github.com/ankit-aglawe/sentimentpredictor/issues)
135135

136+

0 commit comments

Comments
 (0)