File size: 2,431 Bytes
8758d51
522b4ff
 
8758d51
5a4f0d1
8758d51
a4570fe
522b4ff
8758d51
 
2c197b8
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
77f9e05
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2c197b8
 
d9c50cc
2c197b8
 
 
 
 
 
 
 
 
 
 
 
 
d9c50cc
 
2c197b8
 
 
 
 
 
 
 
 
 
 
8758d51
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
tags: 
  - salesken
license: apache-2.0
inference: true
datasets: google_wellformed_query
widget:
  text: "she present paper today"
---

model_card:
  model_name: Salesken's Query Wellformedness Score Model
  description: Evaluate the well-formedness of sentences by checking grammatical correctness and completeness. Sensitive to case and penalizes sentences for incorrect grammar and case.
  features:
    - Wellformedness Score: Provides a score indicating grammatical correctness and completeness.
    - Case Sensitivity: Recognizes and penalizes incorrect casing in sentences.
    - Broad Applicability: Can be used on a wide range of sentences.
  evaluation_results:
    input:
      - She is presenting a paper tomorrow
      - she is presenting a paper tomorrow
      - She present paper today
    scores:
      - 0.8917
      - 0.4270
      - 0.0134

1. Dogs are mammals.
2. she loves to read books on history.
3. When the rain in Spain.
4. Eating apples are healthy for you.
5. The Eiffel Tower is in Paris.

Among these sentences:

Sentences 1 and 5 are well-formed and have correct grammar and case.
Sentence 2 starts with a lowercase letter.
Sentence 3 is a fragment and is not well-formed.
Sentence 4 has a subject-verb agreement error.


  example_usage:
    library: HuggingFace transformers
```python
      from transformers import AutoTokenizer, AutoModelForSequenceClassification
      tokenizer = AutoTokenizer.from_pretrained("salesken/query_wellformedness_score")
      model = AutoModelForSequenceClassification.from_pretrained("salesken/query_wellformedness_score")
      sentences = [
          'what was the reason for everyone to leave the company', 
          'What was the reason behind everyone leaving the company', 
          # ... other sentences
      ]
      features = tokenizer(sentences, padding=True, truncation=True, return_tensors="pt")
      model.eval()
      with torch.no_grad():
          scores = model(**features).logits
      print(scores)
```

  intended_use_cases:
    - Content Creation: Validate the well-formedness of written content.
    - Educational Platforms: Students check the grammaticality of sentences.
    - Chatbots & Virtual Assistants: Validate user queries or generate well-formed responses.
  limitations:
    - Model might have occasional inaccuracies or biases.
    - Long sentences might be truncated, affecting score.
  contact: contact@salesken.ai