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.

Sign up for GitHub

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

Jump to bottom

ruby: New segment callback #2506

Merged
merged 45 commits into from
Oct 28, 2024
Merged

ruby: New segment callback #2506

merged 45 commits into from
Oct 28, 2024

Conversation

KitaitiMakoto
Copy link
Contributor

@KitaitiMakoto KitaitiMakoto commented Oct 24, 2024 •
edited
Loading

Hello, again,

This is rewriting of #2495, which is attempted to add new segment callback feature.

I added methods represent the same to original API as possible such as Whisper::Params#new_segment_callback=, etc:

params.new_segment_callback = ->(context, _state, n_new, user_data) {
  # ...
}
params.new_segment_callback_user_data = {some: "data"}

(_state is not implemented because context can do the same thing and state implementation brings boring memory management, potentially enbugs.)

Additionally, I added "high level API" such as Whisper::Segment class, Whisper::Context#on_new_segment and so on on top of APIs above:

params.on_new_segment do |segment|
  puts segment.start_time
  puts segment.end_time
  puts segment.text
end

Can you consider it? Thanks.

@KitaitiMakoto KitaitiMakoto changed the title New segment callback ruby: New segment callback Oct 24, 2024
ggerganov
ggerganov approved these changes Oct 28, 2024
View reviewed changes
Copy link
Owner

@ggerganov ggerganov left a comment

Choose a reason for hiding this comment

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

Thanks. Again, without understanding the details, the implementation seems OK to me, so happy to merge it. Please resolve the conflict and will proceed with the merge.

@KitaitiMakoto
Add Params#new_segment_callback= method
246793c
@KitaitiMakoto
Add tests for Params#new_segment_callback=
2ccddb9
@KitaitiMakoto
Group tests for #transcribe
0c1ff90
@KitaitiMakoto
Don't use static for thread-safety
1d2d772
@KitaitiMakoto
Set new_segment_callback only when necessary
37aa3c6
@KitaitiMakoto
Remove redundant check
3fec5d3
@KitaitiMakoto
[skip ci] Add Ruby version README
be67fa2
@KitaitiMakoto
Revert "Group tests for #transcribe"
58d3fb6 
This reverts commit 71b65b0.
@KitaitiMakoto
Revert "Add tests for Params#new_segment_callback="
cee8c6a 
This reverts commit 81e6df3.
@KitaitiMakoto
Add test for Context#full_n_segments
b589895
@KitaitiMakoto
Add Context#full_n_segments
8990107
@KitaitiMakoto
Add tests for lang API
a175c5c
@KitaitiMakoto
Add lang API
1c74fdc
@KitaitiMakoto
Add tests for Context#full_lang_id API
588aa1c
@KitaitiMakoto
Add Context#full_lang_id
6e62076
@KitaitiMakoto
Add abnormal test cases for lang
ad55836
@KitaitiMakoto
Raise appropriate errors from lang APIs
e0255a5
@KitaitiMakoto
Add tests for Context#full_get_segment_t{0,1} API
09eb66d
@KitaitiMakoto
Add Context#full_get_segment_t{0,1}
4f261f6
@KitaitiMakoto
Add tests for Context#full_get_segment_speaker_turn_next API
d69e0be
@KitaitiMakoto
Add Context#full_get_segment_speaker_turn_next
9902dcc
@KitaitiMakoto
Add tests for Context#full_get_segment_text
beba539
@KitaitiMakoto
Add Context#full_get_setgment_text
63830b6
@KitaitiMakoto
Add tests for Params#new_segment_callback=
0d1ec5f
@KitaitiMakoto
Run new segment callback
084f450
@KitaitiMakoto
Split tests to multiple files
6128e05
@KitaitiMakoto
Use container struct for new segment callback
c2de24a
@KitaitiMakoto
Add tests for Params#new_segment_callback_user_data=
3f28013
@KitaitiMakoto
Add Whisper::Params#new_user_callback_user_data=
bb4e81c
@KitaitiMakoto
Add GC-related test for new segment callback
f411507
@KitaitiMakoto
Protect new segment callback related structs from GC
79617d7
@KitaitiMakoto
Add meaningful test for build
eae174e
@KitaitiMakoto
Rename: new_segment_callback_user_data -> new_segment_callback_container
30c00c1
@KitaitiMakoto
Add tests for Whisper::Segment
e7f75f1
@KitaitiMakoto
Add Whisper::Segment and Whisper::Context#each_segment
326055a
@KitaitiMakoto
Extract c_ruby_whisper_callback_container_allocate()
1132c9e
@KitaitiMakoto
Add test for Whisper::Params#on_new_segment
ba0fbec
@KitaitiMakoto
Add Whisper::Params#on_new_egment
56c2dfd
@KitaitiMakoto
Assign symbol IDs to variables
87797cc
@KitaitiMakoto
Make extsources.yaml simpler
d94710c
@KitaitiMakoto
Update README
a0cfc22
@KitaitiMakoto
Add document comments
2f925ca
@KitaitiMakoto
Add test for calling Whisper::Params#on_new_segment multiple times
c94c8d4
@KitaitiMakoto
Add file dependencies to GitHub actions config and .gitignore
c5564fc
@KitaitiMakoto
Copy link
Contributor Author

I have rebased. Waiting for GitHub actions complete.

@ggerganov ggerganov merged commit fc49ee4 into ggerganov:master Oct 28, 2024
45 checks passed
@KitaitiMakoto KitaitiMakoto deleted the new_segment_callback branch October 28, 2024 14:35
lyapple2008 pushed a commit to lyapple2008/whisper.cpp.mars that referenced this pull request Nov 2, 2024
@KitaitiMakoto
ruby : support new-segment callback (ggerganov#2506)
457c838 
* Add Params#new_segment_callback= method

* Add tests for Params#new_segment_callback=

* Group tests for #transcribe

* Don't use static for thread-safety

* Set new_segment_callback only when necessary

* Remove redundant check

* [skip ci] Add Ruby version README

* Revert "Group tests for #transcribe"

This reverts commit 71b65b0.

* Revert "Add tests for Params#new_segment_callback="

This reverts commit 81e6df3.

* Add test for Context#full_n_segments

* Add Context#full_n_segments

* Add tests for lang API

* Add lang API

* Add tests for Context#full_lang_id API

* Add Context#full_lang_id

* Add abnormal test cases for lang

* Raise appropriate errors from lang APIs

* Add tests for Context#full_get_segment_t{0,1} API

* Add Context#full_get_segment_t{0,1}

* Add tests for Context#full_get_segment_speaker_turn_next API

* Add Context#full_get_segment_speaker_turn_next

* Add tests for Context#full_get_segment_text

* Add Context#full_get_setgment_text

* Add tests for Params#new_segment_callback=

* Run new segment callback

* Split tests to multiple files

* Use container struct for new segment callback

* Add tests for Params#new_segment_callback_user_data=

* Add Whisper::Params#new_user_callback_user_data=

* Add GC-related test for new segment callback

* Protect new segment callback related structs from GC

* Add meaningful test for build

* Rename: new_segment_callback_user_data -> new_segment_callback_container

* Add tests for Whisper::Segment

* Add Whisper::Segment and Whisper::Context#each_segment

* Extract c_ruby_whisper_callback_container_allocate()

* Add test for Whisper::Params#on_new_segment

* Add Whisper::Params#on_new_egment

* Assign symbol IDs to variables

* Make extsources.yaml simpler

* Update README

* Add document comments

* Add test for calling Whisper::Params#on_new_segment multiple times

* Add file dependencies to GitHub actions config and .gitignore

* Add more files to ext/.gitignore
adutilleul pushed a commit to adutilleul/whisper.cpp that referenced this pull request Nov 19, 2024
@KitaitiMakoto @adutilleul
ruby : support new-segment callback (ggerganov#2506)
7011725 
* Add Params#new_segment_callback= method

* Add tests for Params#new_segment_callback=

* Group tests for #transcribe

* Don't use static for thread-safety

* Set new_segment_callback only when necessary

* Remove redundant check

* [skip ci] Add Ruby version README

* Revert "Group tests for #transcribe"

This reverts commit 71b65b0.

* Revert "Add tests for Params#new_segment_callback="

This reverts commit 81e6df3.

* Add test for Context#full_n_segments

* Add Context#full_n_segments

* Add tests for lang API

* Add lang API

* Add tests for Context#full_lang_id API

* Add Context#full_lang_id

* Add abnormal test cases for lang

* Raise appropriate errors from lang APIs

* Add tests for Context#full_get_segment_t{0,1} API

* Add Context#full_get_segment_t{0,1}

* Add tests for Context#full_get_segment_speaker_turn_next API

* Add Context#full_get_segment_speaker_turn_next

* Add tests for Context#full_get_segment_text

* Add Context#full_get_setgment_text

* Add tests for Params#new_segment_callback=

* Run new segment callback

* Split tests to multiple files

* Use container struct for new segment callback

* Add tests for Params#new_segment_callback_user_data=

* Add Whisper::Params#new_user_callback_user_data=

* Add GC-related test for new segment callback

* Protect new segment callback related structs from GC

* Add meaningful test for build

* Rename: new_segment_callback_user_data -> new_segment_callback_container

* Add tests for Whisper::Segment

* Add Whisper::Segment and Whisper::Context#each_segment

* Extract c_ruby_whisper_callback_container_allocate()

* Add test for Whisper::Params#on_new_segment

* Add Whisper::Params#on_new_egment

* Assign symbol IDs to variables

* Make extsources.yaml simpler

* Update README

* Add document comments

* Add test for calling Whisper::Params#on_new_segment multiple times

* Add file dependencies to GitHub actions config and .gitignore

* Add more files to ext/.gitignore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ggerganov ggerganov ggerganov approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KitaitiMakoto @ggerganov