transformers - 💡(How to fix) Fix fix(generation): correct spelling mistake in continuous_api docstring [1 participants]

TL;DR

Apply the provided patch to correct the spelling mistake in the continuous_api.py docstring.

Guidance

• Review the patch carefully to ensure it only changes the intended line and corrects the spelling mistake from usefull to useful.
• Verify that the patch does not introduce any other changes or side effects.
• Apply the patch to the continuous_api.py file in the src/transformers/generation/continuous_batching directory.
• After applying the patch, review the updated docstring to confirm the correction.

Example

The provided patch is a clear example of the necessary change:

--- a/src/transformers/generation/continuous_batching/continuous_api.py
+++ b/src/transformers/generation/continuous_batching/continuous_api.py
@@ -102,7 +102,7 @@ class ContinuousGenerationApi:
         self.tokenizer = tokenizer
 
     def add_request(self, request: Dict[str, Any]) -> int:
-        """Adds a request to the queue. Returns the request ID. This is usefull if you want to track the request later."""
+        """Adds a request to the queue. Returns the request ID. This is useful if you want to track the request later."""
         return self.queue.add_request(request)

Notes

This fix assumes that the only issue is the spelling mistake in the docstring and that applying the patch will not have any unintended consequences.

Recommendation

Apply the workaround by correcting the spelling mistake in the continuous_api.py docstring, as it is a minor and targeted change that improves the documentation's accuracy.