Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Ngôn ngữ Julia
- Người viết nội dung kỹ thuật:
- mkg33
- Tên dự án:
- Tài liệu hợp nhất về công nghệ học máy khoa học
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Tôi muốn hợp nhất tổ chức SciML vì có rất nhiều điểm cần cải thiện trong lĩnh vực này và việc hoàn thành dự án này chắc chắn sẽ mang lại lợi ích tức thì cho cả các lập trình viên Julia và những người đóng góp/bảo trì tích cực của SciML. Các gói nằm rải rác trong SciML cung cấp một số công cụ thực sự hữu ích nhưng luôn có mối nguy hiểm là chúng có thể không được phát hiện (đặc biệt là đối với những người mới sử dụng) chỉ vì người dùng không thể khám phá gói và áp dụng nó vào vấn đề đang gặp phải.
Điều này khá khó chịu vì mục đích chính của các gói này là tiếp cận một lượng lớn đối tượng lập trình viên (như người mới bắt đầu cũng như chuyên gia). Để tránh tình huống nêu trên, tôi đề xuất sửa đổi kỹ "trang chủ" của tài liệu về SciML, đồng thời tạo ra một loại trung tâm mà người dùng có thể sử dụng để duyệt xem các gói có liên quan và khám phá hệ sinh thái đang ngày càng phát triển. Tài liệu này cũng có thể là tài liệu tham khảo có giá trị cho những người dùng có kinh nghiệm hơn và cho phép họ làm việc hiệu quả hơn.
Trước hết, tài liệu hiện có của tất cả các gói đều cần được chỉnh sửa theo các vấn đề cơ bản nhất về văn phong (chẳng hạn như chính tả, dấu câu, ngữ pháp, v.v.). Để đảm bảo tính nhất quán về kiểu cách, SciML cần có một hướng dẫn văn phong cụ thể (không thể thiếu để thực hiện các thay đổi hồi tưởng và để tham khảo trong tương lai). Sẽ mất thời gian nếu bạn bắt đầu lại từ đầu. Thay vào đó, các báo cáo này phải dựa trên các quy ước hiện có của Julia và bao gồm toàn bộ các vấn đề cụ thể của SciML.
Sau khi hoàn thành hướng dẫn quy tắc, tôi dự định sửa đổi tài liệu hiện tại trong giai đoạn thứ hai của dự án. Điều này sẽ làm cho tài liệu trông chuyên nghiệp và ổn định hơn. Tôi đã tạo một số yêu cầu để minh hoạ cách tiếp cận đối với nhiệm vụ này. Trong giai đoạn này, tôi cũng có ý định thiết kế (và triển khai) một hệ thống trích dẫn hiệu quả. Nhiệm vụ đầu tiên sẽ là cập nhật trang trích dẫn đã lỗi thời.
Giai đoạn thứ ba, có thể là giai đoạn quan trọng nhất, sẽ liên quan đến việc thiết kế lộ trình SciML, trong đó nhấn mạnh sự tương tác giữa các gói phân tán. Sự liên kết giữa hai gói càng chặt chẽ (liên quan đến vấn đề hoặc bản thân mã) thì chúng càng xuất hiện gần hơn trong danh sách "xem thêm". Tôi đề xuất tạo hai khoá đề xuất: một cho sự tương đồng về mã và một cho sự tương đồng về vấn đề. Bằng cách này, người dùng có thể xác định các gói khác có thể hữu ích nhanh hơn nhiều so với việc duyệt qua các kho lưu trữ và tài liệu tương ứng. Thay vì liệt kê tất cả các kết nối có thể có giữa các gói, tôi muốn tập trung vào các gói lớn hơn và cố gắng trình bày liên kết của chúng với các gói nhỏ hơn (phương pháp này cũng sẽ được mở rộng để cập nhật các hướng dẫn trong đó cần chỉ ra kết nối với một gói khác). Phương pháp này đảm bảo danh sách "xem thêm" sẽ cung cấp nhiều thông tin mà không cần liệt kê đầy đủ các kiểu kết hợp gói.