Katkı
Nasıl yardım edilir
NEST, tek bir kişi tarafından yedi ayda yazılmış 24.137 satır Python. Eksikler biliniyor ve aşağıda listelendi. Birini seç, bir issue aç ve küçük bir PR gönder.
Öncelikli alanlar
Yardımın şu an en çok işe yaradığı yerler
Test paketini onar
5 dosyaya yayılmış 80 test fonksiyonu, kod/test kayması yüzünden şu anda import edilemiyor. Bunları yeniden çalışır hale getirmek, tek başına en yüksek etkili katkı.
Paketleme metadata'sı
pyproject.toml içinde [project] tablosu yok, bu yüzden pip install -q -e . çalışmıyor ve kurulabilir bir paket yok.
NEST v2 GPU eğitimini çalıştır
A100'de (tahmini 8–12 saat) günlüklenmiş bir koşu ve değerlendirme raporuyla tam eğitim. "Bekliyor"u gerçek bir sayıya çeviren şey bu.
Gürültü kontrolü betiği
eval_bart ve eval_ctc ile birlikte çalışan, rastgele gürültüyü aynı şekilde çözümleyen bir kontrol değerlendirmesi; böylece her gerçek EEG sayısı kendi kontrolüyle birlikte yayınlanır.
Türkçe korpus protokolü incelemesi
Etik kurul başvurusu ve veri toplamadan önce experiments/user_study/user_study_protocol.md konumundaki okuma-korpus protokolünü oku ve sınırlarını test et.
Donanım adaptörleri
ZuCo referans kurulumunun ötesindeki araştırma sınıfı EEG sistemleri için öznitelik adaptörleri; böylece NEST yalnızca tasarımda değil pratikte de donanımdan bağımsız kalır.
Süreç
Küçük, incelenebilir değişiklikler
- Önemsiz olmayan her şey için önce bir issue aç ve kodu yazmadan önce değişikliği tarif et.
- Pull request'leri küçük tut. PR başına tek bir konu, incelemeyi de geri almayı da kolaylaştırır.
- Conventional commit kullan:
feat:,fix:,docs:,test:. - Push etmeden önce pre-commit'i kur ve çalıştır:
black,isort,flake8,mypy.
Kod stili
İnceleyenin baktığı şeyler
- Tüm fonksiyon imzalarında type hint.
- Dosya yolları için string birleştirme değil,
pathlibkullan. - Biçimlendirme için
.format()veya%değil, f-string kullan. - Çıplak
try/exceptyok. Sadece gerçek sınırlarda ve belirli exception'ları yakala. - Dokümanlarda uydurma metrik yok. Bir sayı günlüklenmiş bir koşuda yoksa docstring'e, README'ye veya PR açıklamasına girmez. Bunun yerine düz söyle: "bekliyor" ya da "ölçülmedi."
Davranış
Doğrudan, dürüst ve nazik ol
NEST'in güvenilirlik problemi bir ölçüm problemi ve bu kültür insanların birbirine davranışına da uygulanıyor: ne demek istiyorsan onu söyle, iddialarını tahmin yerine günlüklenmiş bir koşuyla destekle ve işi eleştirirken kişiye haksızlık etme. Standart bundan ibaret.
Bir issue ile başla
Yukarıdaki öncelikli alanlardan birini seç, ya da kendi fikrini getir. Bir issue aç, oradan devam ederiz.