rapidsai/cuml

[DEBT] rename .h|.hpp|.cuh|.cu|.cpp files properly in our cuml C++ source base

Offen

#1.675 geöffnet am 13.02.2020

Auf GitHub ansehenContributor Guide
 (44 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (644 Forks)auto 404
Build or DepCUDA / C++Tech Debtgood first issueproposal

Repository-Metriken

Stars
 (5.223 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Currently, they are just all over the place! I propose the following rule-of-thumb:

  1. If a header file contains cuda kernels and/or device methods, then it should be a .cuh.
  2. Else, it should be a .hpp (if the current header file is already named as a .h, feel free to leave it as it is, in order to minimize the amount of ripple changes this will cause).
  3. If a header file is used to declare our C interface, it should be a .h
  4. If the header file includes a .cuh, then it should be a .cuh as well
  5. If a source includes a .cuh, then it should be a .cu, else it should be a .cpp
  6. All source files defining our C interface should be .c

This will certainly help us in reducing compilation time as well (if we end up cleaning some of the .cu files and renaming them to .cpp).

Contributor Guide

Research-Richtung
Identifiziere alle Dateien mit den Erweiterungen .h, .hpp, .cuh, .cu, .cpp in der cuml C++ Quellbasis. Benenne sie gemäß den Regeln um: (1) Dateien mit CUDA Kernen werden zu .cuh; (2) sonst .hpp (wenn bereits .h, belassen); (3) C Schnittstellen Header bleiben .h; (4) Header, die ein .cuh enthalten, werden zu .cuh; (5) Quellen, die ein .cuh enthalten, werden zu .cu, sonst .cpp; (6) C Schnittstellen Quellen werden zu .c. Aktualisiere nach der Umbenennung alle #include Anweisungen im Code, um den neuen Dateinamen zu entsprechen. Verwende Git, um Änderungen nachzuverfolgen, und überprüfe die Kompilierung mit dem Build System.
Tech Stack
ccpp
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60