Commit 039ec88b authored by Phil Wang's avatar Phil Wang
Browse files

add some comments in readme and within code

parent 4abc58ed

README.md

+3 −0
Original line number Diff line number Diff line
@@ -44,6 +44,9 @@ ex. `SemanticTransformer` 
import torch

from audiolm_pytorch import HubertWithKmeans, SemanticTransformer, SemanticTransformerTrainer



# hubert checkpoints can be downloaded at

# https://github.com/facebookresearch/fairseq/tree/main/examples/hubert



wav2vec = HubertWithKmeans(

    checkpoint_path = './hubert/hubert_base_ls960.pt',

    kmeans_path = './hubert/hubert_base_ls960_L9_km500.bin'

audiolm_pytorch/hubert_kmeans.py

+5 −0
Original line number Diff line number Diff line
@@ -15,6 +15,11 @@ def exists(val): 
    return val is not None



class HubertWithKmeans(nn.Module):

    """

    checkpoint and kmeans can be downloaded at https://github.com/facebookresearch/fairseq/tree/main/examples/hubert

    or you can train your own

    """



    def __init__(

        self,

        checkpoint_path,

audiolm_pytorch/vq_wav2vec.py

+4 −0
Original line number Diff line number Diff line
@@ -14,6 +14,10 @@ def exists(val): 
    return val is not None



class FairseqVQWav2Vec(nn.Module):

    """

    checkpoint path can be found at https://github.com/facebookresearch/fairseq/blob/main/examples/wav2vec/README.md#vq-wav2vec

    """



    def __init__(

        self,

        checkpoint_path,