README.md

INSTRUCTIONS: This GitHub repository serves as a template and example you can use to create a well documented README for your project for the 2024 Call for Code Global Challenge.

Your required deliverables and project descriptions should be officially submitted to your My Team > Submissions section of the Call for Code Global Challenge web site, but you can also optionally include them here for completeness, as it is good practice to clearly document your project in your README file. Replace the examples seen here with your own deliverable links.

Use the Use this template button to create a new version of this repository and start entering content for your own Call for Code submission project. Make sure you have registered for the 2024 Call for Code Global Challenge to access resources and full project submission instructions. Remove any "INSTRUCTIONS" sections when you are ready to submit your project.

New to Git and GitHub? This free online course will get you up to speed quickly: Getting Started with Git and GitHub.

Replace this heading with your team/submission name

• Project summary
  • The issue we are hoping to solve
  • How our technology solution can help
  • Our idea
• Technology implementation
  • IBM watsonx product(s) used
  • Other IBM technology used
  • Solution architecture
• Presentation materials
  • Solution demo video
  • Project development roadmap
• Additional details
  • How to run the project
  • Live demo
• About this template
  • Contributing
  • Versioning
  • Authors
  • License
  • Acknowledgments

INSTRUCTIONS: Below are the suggested sections to include in your README file to make sure your project is well documented. You can remove this instruction text.

Project summary

The issue we are hoping to solve

REPLACE THIS SENTENCE with a short description, 2-3 sentences in length, of the specific sustainability problem your solution is meant to address.

How our technology solution can help

REPLACE THIS SENTENCE with a short description of your team's solution, in about 10 words.

Our idea

INSTRUCTIONS: Replace this paragraph with a longer description of your solution. In about 500 words, describe your solution in more detail. Include the real-world problem you identified, describe the technological solution you have created, and explain how it’s an improvement over existing solutions. You can supply additional documentation in this source code repository that you link to as well.

More detail is available in our description document.

Technology implementation

IBM watsonx product(s) used

INSTRUCTIONS: Included here is a list of IBM watsonx products. Remove any products you did not use. Leave only those included in your solution code. In your official submission on the Call for Code Global Challenge web site, you are required to provide details on where and how you used each IBM watsonx product so judges can review your implementation. Remove these instructions.

Featured watsonx products

• watsonx.ai - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• watsonx.governance - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• watsonx Assistant - WHERE AND HOW THIS IS USED IN OUR SOLUTION

Other IBM technology used

INSTRUCTIONS: List any other IBM technology or IBM AI services used in your solution and describe how each component was used. If you can provide details on where these were used in your code, that would help the judges review your submission.

Additional IBM AI services (Remove any that you did not use)

• Watson Machine Learning - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• Watson Studio - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• Natural Language Understanding - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• Speech to Text - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• Text to Speech - WHERE AND HOW THIS IS USED IN OUR SOLUTION

• Language Translator - WHERE AND HOW THIS IS USED IN OUR SOLUTION

Solution architecture

REPLACE THIS EXAMPLE WITH YOUR OWN, OR REMOVE THIS EXAMPLE

Diagram and step-by-step description of the flow of our solution:

1. The user navigates to the site and uploads a video file.
2. Watson Speech to Text processes the audio and extracts the text.
3. Watson Translation (optionally) can translate the text to the desired language.
4. The app stores the translated text as a document within Object Storage.

Presentation materials

INSTRUCTIONS: The following deliverables should be officially posted to your My Team > Submissions section of the Call for Code Global Challenge resources site, but you can also include them here for completeness. Replace the examples seen here with your own deliverable links.

Solution demo video

Project development roadmap

The project currently does the following things.

• Feature 1
• Feature 2
• Feature 3

In the future we plan to...

See below for our proposed schedule on next steps after Call for Code 2024 submission.

Additional details

INSTRUCTIONS: The following deliverables are suggested, but optional. Additional details like this can help the judges better review your solution. Remove any sections you are not using.

How to run the project

INSTRUCTIONS: In this section you add the instructions to run your project on your local machine for development and testing purposes. You can also add instructions on how to deploy the project in production.

Live demo

You can find a running system to test at...

See our description document for log in credentials.

---

INSTRUCTIONS: You can remove the below section from your specific project README.

About this template

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Billie Thompson - Initial work - PurpleBooth

License

This project is licensed under the Apache 2 License - see the LICENSE file for details.

Acknowledgments

• Based on Billie Thompson's README template.