Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add TransformersImageToText API doc #3966

Merged
merged 1 commit into from
Jan 27, 2023
Merged

Conversation

agnieszka-m
Copy link
Contributor

@agnieszka-m agnieszka-m commented Jan 26, 2023

Related Issues

  • fixes #issue-number

Proposed Changes:

Add the API documentation for TransformersImageToText

How did you test it?

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added tests that demonstrate the correct behavior of the change
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@agnieszka-m agnieszka-m requested a review from a team as a code owner January 26, 2023 20:54
@agnieszka-m agnieszka-m requested review from vblagoje and removed request for a team January 26, 2023 20:54
@agnieszka-m agnieszka-m merged commit 88650c9 into main Jan 27, 2023
@agnieszka-m agnieszka-m deleted the add-imagetotext-api branch January 27, 2023 08:07
loaders:
- type: python
search_path: [../../../../haystack/nodes/image_to_text]
modules: ['base', `transformers`]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @agnieszka-m it looks like the Generate API docs CI is complaining about the "`" character used around the "transformers" word. I think it needs to be changed to

'transformers'

@agnieszka-m agnieszka-m restored the add-imagetotext-api branch January 27, 2023 09:02
@agnieszka-m agnieszka-m deleted the add-imagetotext-api branch January 27, 2023 09:02
@agnieszka-m agnieszka-m mentioned this pull request Jan 27, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants