(self, generated_doc, reference_doc=None)
| 34 | return flesch_reading_ease |
| 35 | |
| 36 | def evaluate_documentation(self, generated_doc, reference_doc=None): |
| 37 | scores = {} |
| 38 | scores['readability'] = self.calculate_readability(generated_doc) |
| 39 | responses = [section.strip() for section in generated_doc.split('\n') if section.strip()] |
| 40 | scores['consistency'] = self.calculate_consistency(responses) |
| 41 | |
| 42 | if reference_doc: |
| 43 | scores['relevance'] = self.calculate_relevance(generated_doc, reference_doc) |
| 44 | else: |
| 45 | scores['relevance'] = None |
| 46 | |
| 47 | return scores |
| 48 | |
| 49 | # Initialize the evaluator |
| 50 | evaluator = DocumentationEvaluator() |
no test coverage detected