03-12-2022

Refatorando meu projeto horroroso

• Introdução
• Problema
• Solução
  • 03/12/22
  • 24/01/23
  • 25/01/23

Introdução

Desde janeiro eu estou participando de um projeto do IEEE chamado Mentoring Experiences for Underrepresented Young Researchers (ME-UYR), cuja ideia é juntar uma pesquisadora que não tem experiência (eu) com uma pesquisadora que tem muita experiência (no meu caso, a incrível Magdalena Fuentes com a ajuda e suporte dos também incríveis Matthew Davies e Marcelo Queiroz) em um projeto de 9 meses que deve culminar em uma publicação submetida a uma conferência do IEEE¹. Os projetos selecionados receberiam um valor de até $4.000 dólares pra estar presencialmente na conferência.

Pois bem, fiquei os 9 meses trabalhando para tentar traduzir um modelo de self-supervised learning feito para estimação de pitch em um modelo que funcionasse de maneira semelhante para a estimação de tempo de uma música. O trabalho foi muito legal e vou seguir com o tema para o meu mestrado. A gente batizou o projeto de STEME (Self-supervised TEMpo Estimation).

O problema

O desenvolvimento do STEME foi feito em paralelo com o meu trabalho e o meu mestrado, então é de se imaginar que o código tá horroroso porque ele foi feito durante noites longuíssimas, em um modo multi-tarefas e com uma certa privação de sono. Como eu não gosto de código de acadêmico meia-boca e eu não pretendo me tornar uma acadêmica com código meia-boca², decidi usar a oportunidade para refatorar tudo e documentar o processo, atualizando aqui mesmo essa postagem com as coisas que eu for adicionando. Se eu não adicionar nada nunca mais, fica também documentada a minha falta de vergonha na cara.

Algumas coisas que quero fazer (sem ordem de preferência) que consigo pensar de imediato:

• criar testes
• adicionar um linter pra padronizar o código
• criar um README bom, com instruções de instalação
• distribuir melhor as responsabilidades de cada módulo
• documentar melhor as funções
• definir um espaço pra notebooks com exemplos
• separar o código das bibliotecas dos scripts que eu uso pra alguma coisa mais específica

Solução

Eu ainda tenho um emprego e uma tese pra escrever, então as atualizações do STEME serão feitas e documentadas em partes. Esse é o repositório.

03/12/22

• A primeira coisa que eu fiz foi deixar ele público pra que a humilhação também seja pública. Inicialmente, ele estava completamente vazio.

• O projeto original, que eu desenvolvi no decorrer da mentoria, tem muitos diretórios que não cabem estar no repositório do STEME. Pra resolver isso, eu pensei em passar o código-fonte, scripts e exemplos principais pro repositório do STEME e no repositório da mentoria só usar o STEME como sub-módulo³. Organizei os diretórios do STEME me baseando um pouco na organização do cookiecutter, mas dando uma personalizada. Por enquanto ficou desse jeito:

  .
  ├── data
  ├── models
  ├── notebooks
  ├── README.md
  ├── reports
  ├── src
  └── venv
  
  

• O linter que eu usei foi o flake8 junto do autopep8 pra esse início em que eu tive que passar o linter em tudo. O flake8 não consegue forçar as mudanças no código, que é o que o autopep8 faz.
  • Embora eu tenha adicionado o flake8, ainda não fiz todas as mudanças no código que eu queria pra ele não reclamar de nada. Vou fazer isso com calma.

24/01/23

• Finalmente criei um módulo instalável pro código. Não aguentava mais ter que ficar usando sys.path.append(...) toda hora dentro dos notebooks pra conseguir usar os scripts. Agora consigo organizar melhor os exemplos nos notebooks que pretendo subir. Pra ficar mais bonito agora, só tirando os arquivos de teste e os scripts específicos pra uma outra pasta, deixando na src apenas o que é código do modelo em si + as bibliotecas. Inclusive, por questões de instalação, renomeei a pasta de src pra steme, de modo que agora o import fica como

  from steme import audio
  

  em vez de

  from src import audio
  

  talvez valha a pena mencionar que eu poderia ter mantido a pasta com o nome src e ajustado o nome do módulo pra ser steme ao alterar uma das configurações do setup.py. seria algo como:

    """
    this file has setup to distribute this as a package
    """
  
    from setuptools import setup
  
    setup(
            name="steme",
            version=0.1, 
            description="",
            url="",
            author="Giovana Morais",
            email="giovana.vmorais@gmail.com",
            license="",
            # atenção aqui para a mágica:
            package_dir={"steme": "src"},
            packages=["steme"],
            zip_safe=False
    )
  
  

  mas aí eu usei de referência alguns outros módulos que eu uso no dia a dia⁴ e acabei seguindo o exemplo de manter a pasta com o mesmo nome do projeto.

25/01/23

• Feriadinho em São Paulo, então é dia de trabalhar no código. Estava tendo uns problemas com a criação do módulo, mas hoje consegui resolver os problemas remanescentes.

• Ajeitei a organização das pastas e movi os scripts pra uma pasta separada de scripts, então dentro da pasta do steme ficou só as funções principais do módulo.

• Comecei uns notebooks com explicações sobre o modelo e mostrando como ele funciona, mas vou deixar pra fazer subir no GitHub quando terminar e estiver satisfeita com eles.