From dev-return-5197-archive-asf-public=cust-asf.ponee.io@mxnet.incubator.apache.org Thu Dec 20 23:14:42 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 951C6180648 for ; Thu, 20 Dec 2018 23:14:41 +0100 (CET) Received: (qmail 17946 invoked by uid 500); 20 Dec 2018 22:14:40 -0000 Mailing-List: contact dev-help@mxnet.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@mxnet.incubator.apache.org Delivered-To: mailing list dev@mxnet.incubator.apache.org Received: (qmail 17934 invoked by uid 99); 20 Dec 2018 22:14:39 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Dec 2018 22:14:39 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id 92BFCC283E for ; Thu, 20 Dec 2018 22:14:39 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 2.049 X-Spam-Level: ** X-Spam-Status: No, score=2.049 tagged_above=-999 required=6.31 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, HTML_MESSAGE=2, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001] autolearn=disabled Authentication-Results: spamd4-us-west.apache.org (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id J1PzgAtQSCIg for ; Thu, 20 Dec 2018 22:14:38 +0000 (UTC) Received: from mail-io1-f46.google.com (mail-io1-f46.google.com [209.85.166.46]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTPS id 8A0715F501 for ; Thu, 20 Dec 2018 22:14:37 +0000 (UTC) Received: by mail-io1-f46.google.com with SMTP id t24so2134400ioi.0 for ; Thu, 20 Dec 2018 14:14:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=DGifUNvQm94YYPvHsVb12HSl5ERuIeqDNhqS0x1Ziv8=; b=WpLh68voAX/YFdl1XdQrOhye+z8B9DyvuxkH7WePaHld1CcwspYO6snI96Ov2tgz8+ kjonp/wZuocjtLNJ8EyOO4TG4UMjuEU+aGpz/73Z+TI60I3UsRltVVfYiuyCU4hbCEHT 8+qknDuSaGrjml5CJHdJBU4zOUoqcp/H0/8H49REzHjwvif/y/hM0czFpLqpv7lYCY/r l+4eG+xjYQ0xNfWNucrlhURrkrR+UDeIeaYwZ7J2Dy+YybIEduFS4jFW+T59FHzMDWw7 bbbBn+NsZSRwFFcQLusBs/jBu8O5x5pBr8TZFzfATXkuQ7MieQs6G5l4bdHUm1KxKUch z+FQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=DGifUNvQm94YYPvHsVb12HSl5ERuIeqDNhqS0x1Ziv8=; b=QyJTa508OoojaiBeHKJcsRXLt2btnbVc9q6G4DzG0n2LAUQ4Nqf65mTtyCKPL64vBR +fwUoNKjBzKPfvb0AudvLfHD4BvhfLRYGE/7bALPOYAkY2RwCuS0car/LVucHtj6vQhH rEUIys2+niKrIa9oc6P5T1Xqovc6tSextxBlQjFqZYMAG0u+x2U+v720L8VD5utxNsYS Er8ZDk+uFZ1rlbrH8ywulUpBkgKqqV0bq3Wjec9RiUgAVek5ywFNrzRA0gQ7Lp0vSYnF YaA2tvL3KO16NVq0nQFI+Bpr/lKU+aa78MV6YSOT+rGhNG7EXThPZEblsAnVISxKvv74 lpWg== X-Gm-Message-State: AJcUukcWClukhuYNGANNgrbniV4TiqN7mNFr4w+6V6w+tOPVd8AOIuiu NnmCABPGCLdqPIlLiyjhuUFB5Ckc5ZaPu4Ssciaycw== X-Google-Smtp-Source: ALg8bN7OFMvZIRRXrSPom3j/KowehU6LnYJfIYH1yWJ8uYJayiCmLxEv8sTUb8nOxnGLJ0uluEmFqGCvWr0aB4o5n9s= X-Received: by 2002:a5e:9742:: with SMTP id h2mr14742ioq.50.1545344075846; Thu, 20 Dec 2018 14:14:35 -0800 (PST) MIME-Version: 1.0 References: In-Reply-To: From: Anirudh Subramanian Date: Thu, 20 Dec 2018 14:14:23 -0800 Message-ID: Subject: Re: [Question] UI change policy in MXNet To: dev@mxnet.incubator.apache.org Content-Type: multipart/alternative; boundary="000000000000b25944057d7b7477" --000000000000b25944057d7b7477 Content-Type: text/plain; charset="UTF-8" On Thu, Dec 20, 2018, 1:56 PM Lin Yuan Hi Anirudh, > > Thanks a lot for your clarifications! I have some followup > questions/comments: > > 1) Which guideline should we follow when updating the UI in MXNet > operators? > A) MXNet follows semantic versioning, so breaking changes to operator > interfaces can be introduced only in major versions. > > (Lin:) My question is what style of UI guide we should follow. e.g. naming > convension, usage mode, etc. Something like numpy's style or tensorflow? > I don't think there is such an UI guide. If the operator already existed in numpy/scipy or other frameworks we generally tend to use similar interfaces. > > 2) Who should approve the UI change? > A) Contributors who may have worked on the operator and/or other > contributors/committers. > > (Lin:) Is it too local to reply on contributors to one/a few operators to > decide the UI. How can we make sure the consistency of UI across all > operators in MXNet? > agreed. Feel free to propose a better way. > > 3) In case of backward compatibility, should we favor breaking the backward > compatibility and update the release notes or adding a newer version of the > operator like ***_v2? > A) If the operator interfaces are not compatible, its fine to create > operator with the name "_v2" . In the next major version release, you can > add an alias for newer implementation and deprecate the older one. > > (Lin) What if there is already "_v2", do we add "_v3", "_v4" as the project > evolves? > This needs to be dealt on case by case basis. I haven't seen many ops which would require three backward incompatible revisions between two major releases. > > 4) Which operator should go to contrib and which be implemented as regular? > A) I think this discussion may help: > https://github.com/apache/incubator-mxnet/pull/5499 . To summarize: > contrib > was created for ops for which we provide limited guarantees with respect to > backward compatibility, interface changes, testing etc. > > (Lin) This is definitely an informative discussion. It would be better if > we can put this in a more noticeable place for developers. > > > On Thu, Dec 20, 2018 at 1:39 PM Anirudh Subramanian > > wrote: > > > 1) Which guideline should we follow when updating the UI in MXNet > > operators? > > A) MXNet follows semantic versioning, so breaking changes to operator > > interfaces can be introduced only in major versions. > > > > 2) Who should approve the UI change? > > A) Contributors who may have worked on the operator and/or other > > contributors/committers. > > > > 3) In case of backward compatibility, should we favor breaking the > backward > > compatibility and update the release notes or adding a newer version of > the > > operator like ***_v2? > > A) If the operator interfaces are not compatible, its fine to create > > operator with the name "_v2" . In the next major version release, you can > > add an alias for newer implementation and deprecate the older one. > > > > 4) Which operator should go to contrib and which be implemented as > regular? > > A) I think this discussion may help: > > https://github.com/apache/incubator-mxnet/pull/5499 . To summarize: > > contrib > > was created for ops for which we provide limited guarantees with respect > to > > backward compatibility, interface changes, testing etc. > > > > Anirudh > > > > On Thu, Dec 20, 2018 at 1:00 PM Lin Yuan wrote: > > > > > Dear Community, > > > > > > As a contributor, I would like to know the current policy for updating > UI > > > of an operator. I understand UI change should be introduced in major > > > release not minor release. However, it is still not quite clear to me > > > regarding the UI change process: > > > > > > 1) Which guideline should we follow when updating the UI in MXNet > > > operators? > > > 2) Who should approve the UI change? > > > 3) In case of backward compatibility, should we favor breaking the > > backward > > > compatibility and update the release notes or adding a newer version of > > the > > > operator like ***_v2? > > > 4) Which operator should go to contrib and which be implemented as > > regular? > > > > > > Any clarification is appreciated and it is helpful to guide PR > reviewers > > as > > > well. > > > > > > Merry Christmas to ya'all! > > > > > > Lin > > > > > > --000000000000b25944057d7b7477--