Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Julia Dili
- Teknik yazar:
- mkg33
- Projenin adı:
- Bilimsel Makine Öğrenimi ile ilgili birleştirilmiş belgeler
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
SciML organizasyonunun birleştirilmesi için çalışmak istiyorum çünkü bu alanda geliştirilebilecek çok şey var ve bu projenin tamamlanması kuşkusuz hem Julia programcılarına hem de SciML'ye aktif katkıda bulunanlara/bakıcılara anında fayda sağlayacak. SciML'nin dört bir yanına dağılmış halde bulunan paketler gerçekten yararlı araçlar sunuyor. Ancak kullanıcı paketi keşfedip eldeki soruna uygulayamadığı için bunların fark edilmeme (özellikle yeni kullanıcılar tarafından) riski her zaman vardır.
Paketlerin temel amacı, geniş bir programcı kitlesine (yeni başlayanlar ve uzmanlar) ulaşmak olduğu için bu durum oldukça can sıkıcı. Yukarıda açıklanan durumun önüne geçmek için SciML belgelerinin "ön sayfasını" baştan sona gözden geçirmeyi ve kullanıcıların ilgili paketlere göz atmak ve büyüyen ekosistemi keşfetmek için kullanabilecekleri bir merkez oluşturmayı öneriyorum. Ayrıca, daha deneyimli kullanıcılar için değerli bir başvuru noktası olabilir ve kullanıcıların daha verimli bir şekilde çalışmalarına olanak tanıyabilir.
Öncelikle, tüm ayrı paketlerin mevcut belgelerinin, stille ilgili en temel sorunlara (yazım, noktalama, dil bilgisi vb.) göre revize edilmesi gerekir. Stil açısından tutarlılığı sağlamak için SciML'nin açık bir stil kılavuzuna sahip olması gerekir (retrospektif değişiklikleri yapmak ve gelecekte referans olması açısından gereklidir). En baştan başlamak zaman kaybı olacaktır. Bunun yerine, mevcut Julia kurallarına dayanmalı ve SciML'ye özgü sorunlar için yeni bütünler içermelidir.
Stil kılavuzu tamamlandıktan sonra projenin ikinci aşamasında mevcut belgeleri gözden geçirmeyi planlıyorum. Böylece belgeleme daha profesyonel ve istikrarlı hale gelir. Bu göreve yaklaşımımı gösteren birkaç pull isteği zaten oluşturdum. Bu aşamada, etkili bir alıntı sistemi geliştirmeyi (ve uygulamayı) da planlıyorum. İlk görev, güncelliğini yitirmiş alıntılar sayfasını güncellemek olacaktır.
Üçüncü aşama, muhtemelen en önemlisi, dağınık paketler arasındaki etkileşimi vurgulayacak SciML yol haritasının tasarlanmasını içerir. İki paket arasındaki uyum (sorun veya kodun kendisiyle ilgili olarak) ne kadar güçlüyse, paketlerin "ayrıca bakın" listesinde görünmesi o kadar iyi olur. Biri kod benzerliği, diğeri sorun benzerliği için olmak üzere iki öneri anahtarı oluşturmayı öneriyorum. Bu şekilde kullanıcılar, ilgili depo ve belgelere emekli bir şekilde göz atmaktan çok daha hızlı bir şekilde diğer potansiyel olarak yararlı paketleri tespit edebilir. Paketler arasındaki olası tüm bağlantıları listelemek yerine, daha büyük olanlara odaklanmayı ve bağlantılarını daha küçük paketlerle sunmaya çalışmayı tercih ederim (bu yöntem, başka bir paketle bağlantının belirtilmesi gereken bilgilerin güncellenmesine yönelik olarak da öğreticileri güncellemek için genişletilecektir). Bu yaklaşım, "ayrıca bakın" listelerinin paket kombinasyonlarının kapsamlı numaralandırmaları olmadan bilgilendirici olacağını garanti eder.