Quantopian's community platform is shutting down. Please read this post for more information and download your code.
Back to Community
Documentation and Help

I have to say I find the new Documentation profoundly unhelpful.
The old documentation was a lot clearer. I suppose it is because of the desire to have everything done through the optimizer. But if you do need to iterate through your positions in the portfolio, the new documentation gives you very little clue how to do it.

Am I missing something? Have I not looked in the right place?

Old Help Portfolio properties

I'm not trying to be impolite or critical but in the thread about jacking in paper trading you do say you are working on new ways we might be able to design new algos you might find helpful

And as you know many of us do not like the hidden automation of the optimize routines and the neutral everything strategy.

The new documentation is very much designed to do one thing only - the neutral everything, optimize everything, automate everything approach you need for the one strategy you are currently interested in.

Does this make sense? Or am I being obtuse and misguided?

I think you will need better and more detailed documentation, with examples as in the old documentation, if you want to re-attract people to the forum and the project.

9 responses

Compare the information in the old help documentation on the portfolio and position objects to this miserably thin description given in the new:
New

But maybe its just me. Maybe I am a miserable, lazy, ignorant, curmudgeonly old git.

@Zenothestoic -I couldn't imagine you being any of those things. The single page format of the old docs began getting cumbersome as more features were added. While it's often nice to see everything 'all at once' there is a point at which it breaks. We were trying to be proactive. The intent was to encapsulate everything in the original docs plus more.

I personally find the best way to find info in the docs is to use the 'search the docs' feature. It's pretty good and will pull info from all the different sections. In this case search for 'portfolio'. A (rather) long list of results appears. The class definition in the results is similar to the original docs (though I do see there are some omissions - we'll fix that). Check out the two versions original docs and the current docs.

One thing we did with the new docs is to link the class definitions directly to the zipline docstrings. The text in the docs are pulled directly from them. As an example, This should better keep everything aligned. Check out the class description in the docs then the docstring, and actual code, from zipline .

I'd encourage everyone to contact support if you see any omissions or errors in the docs. We can then work to clean them up.

All that said, one can get back to the original docs here. I'll agree there is something comforting in their familiarity. Note this page won't be updated going forward however.

Disclaimer

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.

Dan
Thanks for the answer. The new documents are simply too cryptic. The class definition may be similar but you are given no clue what to do with it (leaving aside the omissions).....The old docs held your hand and there seemed to be countless examples of how to do things including iterating through positions and their values. Perhaps its just me but I find the new documents incomprehensible.

It's about on par with Microsoft help documentation for user friendliness!

And of course no Stackexchange to go and get help from.

Which is one of the biggest benefits of the DIY approach using Python and Pandas rather than the Q IDE and Zipline.

But I admit it is probably my lack of familiarity and experience of these things.

@Zenothestoic - "I couldn't imagine you being any of those things". .... said Dan.

@Zenothestoic: Actually we don't need to imagine .... but we still like you anyway ;-))

I would like to say that the layout of the old documentation wins hands down based on ease of use.

Is there anyway we can revert back to the format of the old documentation?

Thank you everyone for the feedback. The biggest reason we went to the new documentation format is that it requires much less manual updating. It pulls much of the content from the code repositories. This not only saves time, but also reduces the potential for errors. That said, we certainly understand the old format had some advantages. The old site documentation (not data) can still be viewed here. It's not updated so there are certainly things missing however, it should still be accurate and contain 90% of the same information as the current version.

Ok, sure. Thanks Dan!

Hi Dan or any forum members,

I am trying to transition to the current documentation interface after having gotten use to the old interface (quantopian.com/help) . Whilst I am sure that the current interface will be better for me in the long run, I am currently learning how to find information on the current interface which I could have found with ease in the old interface (quantopian.com/help) and would really welcome any help or tips which anyone could provide.

For example, the old interface (quantopian.com/help) has the following writeup on the Future Object. Can I ask where in the current interface can I find the equivalent information?

==========================================================================================

Future object
If you have a reference to a future object (contract), there are several properties that might be useful:

sid

Integer: The id of the contract.

root_symbol

String: The string identifier of the underlying asset for this contract. This is typically the first two characters of the contract identifier.

symbol

String: The string identifier of the contract.

exchange

String: The exchange that the contract is trading on.

tick_size

String: The minimum amount that the price can change for this contract.

multiplier

String: The contract size. The size of a futures contract is the deliverable quantitiy of underlying assets.

asset_name

String: The full name of the underlying asset for this contract.

start_date

Datetime: The date when this contract first started trading.

notice_date

Datetime: The first notice date of this contract (reference).

end_date

Datetime: The last traded date for this contract (reference).

auto_close_date

Datetime: The auto_close_date is two trading days before the earlier of the notice_date and the end_date. Algorithms are not able to trade contracts past their auto_close_date, and have any held contracts closed out at this point. This is done to protect an algorithm from having to take delivery on a contract.

expiration_date

Datetime: The date when this contract expires.

exchange_full

String: The full name of the exchange that the contract is trading on.