You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by "Dmitriy Lyubimov (Commented) (JIRA)" <ji...@apache.org> on 2011/12/23 00:55:30 UTC

[jira] [Commented] (MAHOUT-831) @Experimental annotation to indicate which implementations are not intended for production use

    [ https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175173#comment-13175173 ] 

Dmitriy Lyubimov commented on MAHOUT-831:
-----------------------------------------

is it appearing in javadoc with the metadata? Looks good. 

I would also add 
{code}

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
{code}

to indicate appropriate use.
                
> @Experimental annotation to indicate which implementations are not intended for production use
> ----------------------------------------------------------------------------------------------
>
>                 Key: MAHOUT-831
>                 URL: https://issues.apache.org/jira/browse/MAHOUT-831
>             Project: Mahout
>          Issue Type: Improvement
>    Affects Versions: 0.6
>            Reporter: Sebastian Schelter
>            Assignee: Sebastian Schelter
>         Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch, MAHOUT-831.patch
>
>


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Re: [jira] [Commented] (MAHOUT-831) @Experimental annotation to indicate which implementations are not intended for production use

Posted by Jeff Eastman <jd...@windwardsolutions.com>.
Yes I agree, pending the refactoring and classification API convergence 
it is premature to mark the clustering as @Stable at this point. I like 
to think some stability can be maintained in the CLI APIs even through 
this transition. I'd like to have @Stable clustering APIs by 0.8.

On 12/22/11 6:21 PM, Ted Dunning wrote:
> I don't think we so much have a criterion as we have a vote.
>
> Seriously, the criterion is that when we are happy freezing the interface,
> then we mark it as @Stable.  During the period that we are changing it
> every few moments, we don't.
>
> Along these lines, most of the recommendation stuff is pretty stable.  SGD
> is kind of sort of borderline.  The clustering stuff has a pending Big
> Change so we would be more cautious about freezing.
>
> On Thu, Dec 22, 2011 at 5:14 PM, Jeff Eastman<jd...@windwardsolutions.com>wrote:
>
>> +1 and I'd love to see that patch. It begs the question: "Do we have/need
>> a criteria for removing the @Experimental designation?"
>>
>> On 12/22/11 5:01 PM, Ted Dunning wrote:
>>
>>> In my small test, these annotations did appear in the javadoc.  The trick
>>> is the @Documented meta-annotation.
>>>
>>> I don't know what Retention and Target should mean.  This was my beef with
>>> Maturity as well.  If there is a natural meaning that I am missing then it
>>> would be fine.
>>>
>>> Once we converge on an annotation scheme, I will produce and commit a
>>> mega-patch that adds these annotations to lots of classes.
>>>
>>> On Thu, Dec 22, 2011 at 3:55 PM, Dmitriy Lyubimov (Commented) (JIRA)<
>>> jira@apache.org>   wrote:
>>>
>>>      [
>>>> https://issues.apache.org/**jira/browse/MAHOUT-831?page=**
>>>> com.atlassian.jira.plugin.**system.issuetabpanels:comment-**
>>>> tabpanel&focusedCommentId=**13175173#comment-13175173<https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175173#comment-13175173>
>>>> ]
>>>>
>>>> Dmitriy Lyubimov commented on MAHOUT-831:
>>>> ------------------------------**-----------
>>>>
>>>> is it appearing in javadoc with the metadata? Looks good.
>>>>
>>>> I would also add
>>>> {code}
>>>>
>>>> @Retention(RetentionPolicy.**CLASS)
>>>> @Target(ElementType.TYPE)
>>>> {code}
>>>>
>>>> to indicate appropriate use.
>>>>
>>>>   @Experimental annotation to indicate which implementations are not
>>>> intended for production use
>>>> ------------------------------**------------------------------**
>>>> ------------------------------**----
>>>>
>>>>>                  Key: MAHOUT-831
>>>>>                  URL: https://issues.apache.org/**jira/browse/MAHOUT-831<https://issues.apache.org/jira/browse/MAHOUT-831>
>>>>>              Project: Mahout
>>>>>           Issue Type: Improvement
>>>>>     Affects Versions: 0.6
>>>>>             Reporter: Sebastian Schelter
>>>>>             Assignee: Sebastian Schelter
>>>>>          Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch,
>>>>>
>>>> MAHOUT-831.patch
>>>>
>>>>>
>>>> --
>>>> This message is automatically generated by JIRA.
>>>> If you think it was sent incorrectly, please contact your JIRA
>>>> administrators:
>>>> https://issues.apache.org/**jira/secure/**ContactAdministrators!default.
>>>> **jspa<https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa>
>>>> For more information on JIRA, see: http://www.atlassian.com/**
>>>> software/jira<http://www.atlassian.com/software/jira>
>>>>
>>>>
>>>>
>>>>


Re: [jira] [Commented] (MAHOUT-831) @Experimental annotation to indicate which implementations are not intended for production use

Posted by Ted Dunning <te...@gmail.com>.
I don't think we so much have a criterion as we have a vote.

Seriously, the criterion is that when we are happy freezing the interface,
then we mark it as @Stable.  During the period that we are changing it
every few moments, we don't.

Along these lines, most of the recommendation stuff is pretty stable.  SGD
is kind of sort of borderline.  The clustering stuff has a pending Big
Change so we would be more cautious about freezing.

On Thu, Dec 22, 2011 at 5:14 PM, Jeff Eastman <jd...@windwardsolutions.com>wrote:

> +1 and I'd love to see that patch. It begs the question: "Do we have/need
> a criteria for removing the @Experimental designation?"
>
> On 12/22/11 5:01 PM, Ted Dunning wrote:
>
>> In my small test, these annotations did appear in the javadoc.  The trick
>> is the @Documented meta-annotation.
>>
>> I don't know what Retention and Target should mean.  This was my beef with
>> Maturity as well.  If there is a natural meaning that I am missing then it
>> would be fine.
>>
>> Once we converge on an annotation scheme, I will produce and commit a
>> mega-patch that adds these annotations to lots of classes.
>>
>> On Thu, Dec 22, 2011 at 3:55 PM, Dmitriy Lyubimov (Commented) (JIRA)<
>> jira@apache.org>  wrote:
>>
>>     [
>>> https://issues.apache.org/**jira/browse/MAHOUT-831?page=**
>>> com.atlassian.jira.plugin.**system.issuetabpanels:comment-**
>>> tabpanel&focusedCommentId=**13175173#comment-13175173<https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175173#comment-13175173>
>>> ]
>>>
>>> Dmitriy Lyubimov commented on MAHOUT-831:
>>> ------------------------------**-----------
>>>
>>> is it appearing in javadoc with the metadata? Looks good.
>>>
>>> I would also add
>>> {code}
>>>
>>> @Retention(RetentionPolicy.**CLASS)
>>> @Target(ElementType.TYPE)
>>> {code}
>>>
>>> to indicate appropriate use.
>>>
>>>  @Experimental annotation to indicate which implementations are not
>>>>
>>> intended for production use
>>> ------------------------------**------------------------------**
>>> ------------------------------**----
>>>
>>>>                 Key: MAHOUT-831
>>>>                 URL: https://issues.apache.org/**jira/browse/MAHOUT-831<https://issues.apache.org/jira/browse/MAHOUT-831>
>>>>             Project: Mahout
>>>>          Issue Type: Improvement
>>>>    Affects Versions: 0.6
>>>>            Reporter: Sebastian Schelter
>>>>            Assignee: Sebastian Schelter
>>>>         Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch,
>>>>
>>> MAHOUT-831.patch
>>>
>>>>
>>>>
>>> --
>>> This message is automatically generated by JIRA.
>>> If you think it was sent incorrectly, please contact your JIRA
>>> administrators:
>>> https://issues.apache.org/**jira/secure/**ContactAdministrators!default.
>>> **jspa<https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa>
>>> For more information on JIRA, see: http://www.atlassian.com/**
>>> software/jira <http://www.atlassian.com/software/jira>
>>>
>>>
>>>
>>>
>

Re: [jira] [Commented] (MAHOUT-831) @Experimental annotation to indicate which implementations are not intended for production use

Posted by Jeff Eastman <jd...@windwardsolutions.com>.
+1 and I'd love to see that patch. It begs the question: "Do we 
have/need a criteria for removing the @Experimental designation?"

On 12/22/11 5:01 PM, Ted Dunning wrote:
> In my small test, these annotations did appear in the javadoc.  The trick
> is the @Documented meta-annotation.
>
> I don't know what Retention and Target should mean.  This was my beef with
> Maturity as well.  If there is a natural meaning that I am missing then it
> would be fine.
>
> Once we converge on an annotation scheme, I will produce and commit a
> mega-patch that adds these annotations to lots of classes.
>
> On Thu, Dec 22, 2011 at 3:55 PM, Dmitriy Lyubimov (Commented) (JIRA)<
> jira@apache.org>  wrote:
>
>>     [
>> https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175173#comment-13175173]
>>
>> Dmitriy Lyubimov commented on MAHOUT-831:
>> -----------------------------------------
>>
>> is it appearing in javadoc with the metadata? Looks good.
>>
>> I would also add
>> {code}
>>
>> @Retention(RetentionPolicy.CLASS)
>> @Target(ElementType.TYPE)
>> {code}
>>
>> to indicate appropriate use.
>>
>>> @Experimental annotation to indicate which implementations are not
>> intended for production use
>> ----------------------------------------------------------------------------------------------
>>>                  Key: MAHOUT-831
>>>                  URL: https://issues.apache.org/jira/browse/MAHOUT-831
>>>              Project: Mahout
>>>           Issue Type: Improvement
>>>     Affects Versions: 0.6
>>>             Reporter: Sebastian Schelter
>>>             Assignee: Sebastian Schelter
>>>          Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch,
>> MAHOUT-831.patch
>>>
>>
>> --
>> This message is automatically generated by JIRA.
>> If you think it was sent incorrectly, please contact your JIRA
>> administrators:
>> https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
>> For more information on JIRA, see: http://www.atlassian.com/software/jira
>>
>>
>>


Re: [jira] [Commented] (MAHOUT-831) @Experimental annotation to indicate which implementations are not intended for production use

Posted by Ted Dunning <te...@gmail.com>.
In my small test, these annotations did appear in the javadoc.  The trick
is the @Documented meta-annotation.

I don't know what Retention and Target should mean.  This was my beef with
Maturity as well.  If there is a natural meaning that I am missing then it
would be fine.

Once we converge on an annotation scheme, I will produce and commit a
mega-patch that adds these annotations to lots of classes.

On Thu, Dec 22, 2011 at 3:55 PM, Dmitriy Lyubimov (Commented) (JIRA) <
jira@apache.org> wrote:

>
>    [
> https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175173#comment-13175173]
>
> Dmitriy Lyubimov commented on MAHOUT-831:
> -----------------------------------------
>
> is it appearing in javadoc with the metadata? Looks good.
>
> I would also add
> {code}
>
> @Retention(RetentionPolicy.CLASS)
> @Target(ElementType.TYPE)
> {code}
>
> to indicate appropriate use.
>
> > @Experimental annotation to indicate which implementations are not
> intended for production use
> >
> ----------------------------------------------------------------------------------------------
> >
> >                 Key: MAHOUT-831
> >                 URL: https://issues.apache.org/jira/browse/MAHOUT-831
> >             Project: Mahout
> >          Issue Type: Improvement
> >    Affects Versions: 0.6
> >            Reporter: Sebastian Schelter
> >            Assignee: Sebastian Schelter
> >         Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch,
> MAHOUT-831.patch
> >
> >
>
>
> --
> This message is automatically generated by JIRA.
> If you think it was sent incorrectly, please contact your JIRA
> administrators:
> https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
> For more information on JIRA, see: http://www.atlassian.com/software/jira
>
>
>