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

Narration Capture Mode #48

Open
wants to merge 48 commits into
base: development
Choose a base branch
from
Open

Narration Capture Mode #48

wants to merge 48 commits into from

Conversation

chirag03k
Copy link
Collaborator

@chirag03k chirag03k commented May 26, 2021

Initial PR for Narration Capture Mode

See Issue #40 for more information on the capabilities and limitations of this right now.

Directions for Use
STEP 1: Create storydata.json for a particular story, but leave out segmentation and narration data in the storydata.json file

STEP 2: In the downloads folder of the android device, create a folder with the story title, and in it create another folder with the story title + an underscore + a level number (e.g. if the story was titled, say, "butterflies" and the level was "1", you should have the file structure "Downloads/butterfly/butterflies_1"). Save the storydata.json in the subfolder.

STEP 3: Configure debug.json to look like the following. Replace "storyName_level" with your story name and level identical to the subfolder created earlier.

  { 
    "type": "TRANSITION", 
    "skill": "stories", 
    "tutor_id": "story.echo::storyName_level", 
    "tutor_desc":"story.echo", 
    "tutor_data": "[unpackaged_asset]storyName_level",
    "use_hash_name": "false"
  }

STEP 4: Configure config.json to include the following variable:

  "content_creation_mode": false

STEP 5: Launch RoboTutor.

@JackMostow - So far, everything about this seems to work, aside from recognition issues. I am not sure if this is device specific. Does creating this PR create an apk that you can test? If not, I'll send you one that I generate.

… with windows. TODO: Change it back when I make the final commit.
Added Config.json variable - content_creation_mode in order to enable narrate mode
Added empty methods to CRt_ViewManagerMari.java - they may need to be filled in if this class is actually used
Added FTR_NARRATE_MODE to TCONST
- Added ability to launch tutor using debug.json
- Finished saving feature (storydata.json is edited accordingly)
- Added segmentation information
- Added necessary framework for story navigation (UI needs to be made)
- TODO: fix bug where the buttons are not found by the ViewManager (returns null, causing a NullPointerException to be thrown)
-remove_noise and -remove_silence set to false in ListenerBase
Steps: go to line 1838 of CRt_ViewManagerASB.java and make sure doNotTruncate is set to true if you want to NOT truncate, and FALSE if you want mean mode as usual
 - now the code for debug.json doesn't need to be changed in order to add a new variable
- Still need to figure out why the last word is sometimes omitted
@chirag03k
Copy link
Collaborator Author

Fixed.

Copy link
Contributor

@JackMostow JackMostow left a comment

Choose a reason for hiding this comment

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

@chirag03k -

  • Merging master into anything surprised me. Was merging master into narrate_mode the way you incorporated the master commits made between your first narrate_mode commit on 8/26/2020 and the most recent master commit on 1/11/2021? Does narrate_mode actually depend on any of those commits? I assume it doesn't depend on any subsequent commits to development, which will get included by merging narrate_mode into development.

  • The config.json here works only for English. Instead of specifying a particular config.json, please specify just the particular settings required for narration.

  • Why "content_creation_mode": false? Shouldn't it be true for narrate_mode?

  • @sansyrox - The apk branch doesn't yet have an apk for narrate_mode. I thought issuing a PR to development generates an apk automatically, but it didn't yet. I gather it requires something more, namely what -- resolving conflicts?

@sansyrox
Copy link
Collaborator

@sansyrox - The apk branch doesn't yet have an apk for narrate_mode. I thought issuing a PR to development generates an apk automatically, but it didn't yet. I gather it requires something more, namely what -- resolving conflicts?

@JackMostow , there are many conflicts that need to be resolved. After that the apk generation will be triggered.

@chirag03k
Copy link
Collaborator Author

@JackMostow -

  1. Merging master into narrate mode was actually unintended, but it was actually meaningless because master had 0 commits between when I started working in narrate mode and when I merged it, so I didn’t revert the merge.
  2. and 3. You are right about both of these. I’ll fix them. Content creation mode being false is a typo.
  3. Should I email you my own apk?

@JackMostow
Copy link
Contributor

@chirag03k

  1. I think mailing apks is prohibited. Besides, they’re big. Please put it in GDrive instead.
  2. Please try RoboTutor-CMNINIT_WARMUP_FIX-2021-05-25.apk -- do you get the same problem I get but others don't?
  3. (Where) have you by any chance found the source code for decoder.getInSpeech called by comp_listener/src/main/java/edu/cmu/xprize/listener/SpeechRecognizer.java l. 686? It's in a Sphinx library used by RoboTutor, not in RoboTutor itself.
  4. See you at 4pm ET today unless sooner is good.
    Thanks! – Jack

3f984cd#diff-12643fc3c660cc99685c264511694814e6afa617510fb2b557f2f3892701629e

@chirag03k
Copy link
Collaborator Author

I'll need to fix the gradle issues with compiling the apk and upload to GDrive accordingly.

@JackMostow
Copy link
Contributor

@chirag03k - I think an apk won't get auto-generated until the branch passes automated checks that it currently doesn't.

@chirag03k
Copy link
Collaborator Author

chirag03k commented Jun 8, 2021

I resolved all the merge conflicts, but it was a little messy because I used vscode and accidentally updated some configuration files. Hopefully an apk can be autogenerated now.

chirag03k and others added 12 commits June 9, 2021 12:56
* Improve cloud scripts

* Add more docs

* Add script for automatic apk generation

* Update travis scripts
* Build pipeline final commit

* Add more changes

* Update

* Add final token
* Build pipeline script bug fix

* Add more descriptive commit message
* Add the git hook for automatic version numbering

* Add documentation

* Version number included in apk filename

Co-authored-by: Sushant <[email protected]>
@chirag03k
Copy link
Collaborator Author

I cherry-picked commits from development that weren't merging into narrate_mode becuase they were integral to the functioning of travis. I also resolved the conflicts on github.

@chirag03k chirag03k closed this Jul 17, 2021
@chirag03k chirag03k reopened this Jul 17, 2021
@JackMostow
Copy link
Contributor

@chirag03k #48 for narrate_mode still has conflicts in comp_listener/src/main/java/edu/cmu/xprize/listener/SpeechRecognizer.java to resolve. Can you do it?

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.0.0.1 add NARRATE and EDIT modes
3 participants