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

Add AI Transcription Guide #24

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add AI Transcription Guide #24

wants to merge 1 commit into from

Conversation

giraffekey
Copy link

@giraffekey giraffekey commented Aug 19, 2024 •
edited
Loading

AI Transcription Guide

I wrote this assuming that nkkko/sapat#1 will be accepted.

/claim #13

Writer's Checklist

  • Follow Writing Structure

    • I have used more than two H2 subtitles to organize content.
    • Include an introduction with at least two paragraphs before the first H2 section.
    • Use bold, italic, underline, notes, quotes, TLDRs, and key points as needed.
    • Include code elements where appropriate.
    • Write the article in Markdown format.

  • Fact-Check

    • I have verified all facts and data points included in the article.

  • Assets

    • Save images in the /assets folder.
    • Follow naming conventions: YYYYMMDD_title_of_the_article_IMG_NAME_NO.png.

  • Interlinking

  • Glossary/Definitions

    • Identify and mark new terms that could be added to the Definitions page.

  • Review and Edit

    • Read the article out loud to catch any awkward phrasing.
    • Run the draft through Grammarly or a similar tool to correct grammar and spelling errors.
    • Double-check adherence to the style guide and repository guidelines.

@algora-pbc algora-pbc bot mentioned this pull request Aug 19, 2024
Open
nkkko
nkkko requested changes Aug 20, 2024
View reviewed changes
Copy link
Member

@nkkko nkkko left a comment

Choose a reason for hiding this comment

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

Overall 5/10, could you rewrite it a bit to focus on motivating developers to play with ai tools like whisper, get them introduced to api, show them how they can quickly prototype such project with Daytona. The idea is to show the magic of quickly spinning the project and getting your ideas into functioning code.

Could you please add some diagrams or images to illustrate it a bit.

Thank you.

guides/20240819_ai_transcription.md
@@ -0,0 +1,312 @@
---
title: "Transcribe Video and Audio with Python"
description: "This guide provides a comprehensive step-by-step process for setting up and using Sapat to automatically transcribe video and audio files using Azure OpenAI's Whisper API."
Copy link
Member

Choose a reason for hiding this comment

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

Maybe to be more generic and just state OpenaAI Whisper compatible API or whatever is correct?

guides/20240819_ai_transcription.md
By following this guide, you will learn how to set up the necessary environment, install the required software, and use the [transcription](/definitions/transcription.md) tool. The tool supports processing individual video files or entire directories, ensuring temporary MP3 files are cleaned up after [transcription](/definitions/transcription.md). You can choose between using Azure OpenAI's Whisper API or Rev AI API based on your preference and access. A basic understanding of Python and command-line operations, as well as access to the relevant API, is required.

### Prerequisites

Copy link
Member

Choose a reason for hiding this comment

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

only prereq should be daytona and repo with appropriate devcontainer that will set all of the prereq which I have in the repo.

with every article the main idea is to show how daytona simplifies development, quick hacking/prototyping, oss contributions, etc.

@nkkko
Copy link
Member

nkkko commented Aug 20, 2024

Please be mindful of the checklist and don't check stuff if it is not done, for example assets. Thanks.

@mojafa
Copy link
Collaborator

mojafa commented Dec 2, 2024

@giraffekey guide fails DCO check

@giraffekey
Add ai transcription guide
c267a02 
Signed-off-by: giraffekey <[email protected]>
@giraffekey giraffekey force-pushed the ai-transcription-guide branch from e17041a to c267a02 Compare December 5, 2024 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nkkko nkkko nkkko requested changes

Assignees
No one assigned
Labels
🙋 Bounty claim
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@giraffekey @nkkko @mojafa